Initial repo setup

archivesunleashed · Apr 11, 2019 · 3ec8a8640c7f3704fd1f253495b29c3b9bb0ae3f · 3ec8a86
1 parent f4cf356
commit 3ec8a8640c7f3704fd1f253495b29c3b9bb0ae3f
diff --git a/.codecov.yml b/.codecov.yml
@@ -0,0 +1,11 @@
+  
+codecov:
+  
+  # Default branch for CodeCov information
+  
+  branch: master
+  
+
+  
+coverage:
+  
+  status:
+  
+    project:
+  
+      default:
+  
+        # Only against master
+  
+        branches:
+  
+        - master
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+  
+au_notebook.egg-info
+  
+build
+  
+dist
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,2 @@
+  
+language: python
+  
+script: python setup.py test
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,81 @@
+  
+# Archives Unleashed Project Code of Conduct
+  
+
+  
+## Our Pledge
+  
+
+  
+* The Archives Unleashed Project believes in supporting an open, inclusive, and
+  
+ diverse community which respects the experience, expertise, and knowledge of
+  
+all community members.
+  
+* The Archives Unleashed community is dedicated to providing a harassment-free
+  
+ experience for everyone, and welcomes individuals regardless age, body size,
+  
+disability, ethnicity, gender identity and expression, level of experience,
+  
+nationality, personal appearance, race, religion, or sexual identity and
+  
+orientation.
+  
+* To foster respectful collaborations this code of conduct applies to all
+  
+Archives Unleashed spaces, includes, but is not limited to, GitHub, Slack,
+  
+Medium, social media platforms and meeting spaces, both online and off.
+  
+* Anyone who violates this code of conduct may be sanctioned or expelled from
+  
+ these spaces at the discretion of the Archives Unleashed Project Team.
+  
+
+  
+## Our Standards
+  
+
+  
+Examples of behavior that contributes to creating a positive environment
+  
+include:
+  
+
+  
+* Using welcoming and inclusive language
+  
+* Being respectful of differing viewpoints and experiences
+  
+* Gracefully accepting constructive criticism
+  
+* Focusing on what is best for the community
+  
+* Showing empathy towards other community members
+  
+
+  
+Examples of unacceptable behavior by participants include:
+  
+
+  
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  
+advances
+  
+* Trolling, insulting/derogatory comments, and personal or political attacks
+  
+* Public or private harassment
+  
+* Publishing others' private information, such as a physical or electronic
+  
+  address, without explicit permission
+  
+* Other conduct which could reasonably be considered inappropriate in a
+  
+  professional setting
+  
+
+  
+## Our Responsibilities
+  
+
+  
+Project maintainers are responsible for clarifying the standards of acceptable
+  
+behavior and are expected to take appropriate and fair corrective action in
+  
+response to any instances of unacceptable behavior.
+  
+
+  
+Project maintainers have the right and responsibility to remove, edit, or
+  
+reject comments, commits, code, wiki edits, issues, and other contributions
+  
+that are not aligned to this Code of Conduct, or to ban temporarily or
+  
+permanently any contributor for other behaviors that they deem inappropriate,
+  
+threatening, offensive, or harmful.
+  
+
+  
+## Scope
+  
+
+  
+This Code of Conduct applies both within project spaces and in public spaces
+  
+when an individual is representing the project or its community. Examples of
+  
+representing a project or community include using an official project e-mail
+  
+address, posting via an official social media account, or acting as an appointed
+  
+representative at an online or offline event. Representation of a project may be
+  
+further defined and clarified by project maintainers.
+  
+
+  
+## Enforcement
+  
+
+  
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+  
+reported by contacting the project team at archivesunleashed@gmail.com. All
+  
+complaints will be reviewed and investigated and will result in a response that
+  
+is deemed necessary and appropriate to the circumstances. The project team is
+  
+obligated to maintain confidentiality with regard to the reporter of an incident.
+  
+Further details of specific enforcement policies may be posted separately.
+  
+
+  
+Project maintainers who do not follow or enforce the Code of Conduct in good
+  
+faith may face temporary or permanent repercussions as determined by other
+  
+members of the project's leadership.
+  
+
+  
+## Attribution
+  
+
+  
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+  
+available at [http://contributor-covenant.org/version/1/4][version]
+  
+
+  
+[homepage]: http://contributor-covenant.org
+  
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+  
+# Welcome!
+  
+
+  
+If you are reading this document then you are interested in contributing `au_notebook`. All contributions are welcome: use-cases, documentation, code, ptatches, bug reports, feature requests, etc. You do not need to be a programmer to speak up!
+  
+
+  
+### Use cases
+  
+
+  
+If you would like to submit a use case for AUK, please submit and issue [here](https://github.com/archivesunleashed/au_notebook/issues/new), and begin the issue title with "Use Case:".
+  
+
+  
+### Documentation
+  
+
+  
+You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/archivesunleashed/au_notebook/issues/new) and begin the issue title with "Documentation:".
+  
+
+  
+### Request a new feature
+  
+
+  
+To request a new feature you should [open an issue](https://github.com/archivesunleashed/au_notebook/issues/new) or create a use case as described above (see _use case_ section above), and summarize the desired functionality. Begin the issue title with "Enhancement:".
+  
+
+  
+### Report a bug
+  
+
+  
+To report a bug you should [open an issue](https://github.com/archivesunleashed/au_notebook/issues/new) that summarizes the bug, and begin the issue title with "Bug".
+  
+
+  
+In order to help us understand and fix the bug it would be great if you could provide us with:
+  
+
+  
+1. The steps to reproduce the bug. This includes information about e.g. The AUK version you were using.
+  
+2. The expected behavior.
+  
+3. The actual, incorrect behavior.
+  
+
+  
+Feel free to search the issue queue for existing issues (aka tickets) that already describe the problem; if there is such a ticket please add your information as a comment.
+  
+
+  
+### Contribute code
+  
+
+  
+_If you are interested in contributing code to AUK but do not know where to begin:_
+  
+
+  
+In this case you should [browse open issues](https://github.com/archivesunleashed/au_notebook/issues).
+  
+
+  
+Contributions to AUK codebase should be sent as GitHub pull requests. See section _Create a pull request_ below for details. If there is any problem with the pull request we can work through it using the commenting features of GitHub.
+  
+
+  
+* For _small patches_, feel free to submit pull requests directly for those patches.
+  
+* For _larger code contributions_, please use the following process. The idea behind this process is to prevent any wasted work and catch design issues early on.
+  
+
+  
+    1. [Open an issue](https://github.com/archivesunleashed/au_notebook/issues), if a similar issue does not exist already. If a similar issue does exist, then you may consider participating in the work on the existing issue.
+  
+    2. Comment on the issue with your plan for implementing the issue. Explain what pieces of the codebase you are going to touch and how everything is going to fit together.
+  
+    3. The AUK committers will work with you on the design to make sure you are on the right track.
+  
+    4. Implement your issue, create a pull request (see below), and iterate from there.
+  
+
+  
+### Create a pull request
+  
+
+  
+Take a look at [Creating a pull request](https://help.github.com/articles/creating-a-pull-request). In a nutshell you need to:
+  
+
+  
+1. [Fork](https://help.github.com/articles/fork-a-repo) the AUK GitHub repository at [https://github.com/archivesunleashed/au_notebook](https://github.com/archivesleashed/auk) to your personal GitHub account.
+  
+2. Commit any changes to your fork.
+  
+3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) to AUK GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/archivesunleashed/aut/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from.
+  
+
+  
+You may want to read [Syncing a fork](https://help.github.com/articles/syncing-a-fork) for instructions on how to keep your fork up to date with the latest changes of the upstream (official) `aut` repository.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,11 @@
+  
+Licensed under the Apache License, Version 2.0 (the "License");
+  
+you may not use this file except in compliance with the License.
+  
+You may obtain a copy of the License at
+  
+
+  
+  http://www.apache.org/licenses/LICENSE-2.0
+  
+
+  
+Unless required by applicable law or agreed to in writing, software
+  
+distributed under the License is distributed on an "AS IS" BASIS,
+  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  
+See the License for the specific language governing permissions and
+  
+limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+  
+# au_notebook
+  
+[![Build Status](https://travis-ci.org/archivesunleashed/au_notebook.svg?branch=master)](https://travis-ci.org/archivesunleashed/au_notebook)
+  
+[![codecov](https://codecov.io/gh/archivesunleashed/au_notebook/branch/master/graph/badge.svg)](https://codecov.io/gh/archivesunleashed/au_notebook)
+  
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+  
+[![LICENSE](https://img.shields.io/badge/license-Apache-blue.svg?style=flat-square)](./LICENSE)
+  
+
+  
+## Description
+  
+
+  
+This module is intended for use with Archives Unleashed Cloud derivative data and the [Archives Unleashed Cloud Notebooks](https://raw.githubusercontent.com/archivesunleashed/au_notebook-notebooks).
+  
+
+  
+## Installation
+  
+
+  
+`au_notebook.py` is a single-file Python module that you can drop into your project as needed or you can install globally with:
+  
+
+  
+1. `git clone https://github.com/archivesunleashed/au_notebook.git`
+  
+2. `cd au_notebook`
+  
+3. `python setup.py install`
+  
+
+  
+or:
+  
+
+  
+`pip install au_notebook`
+  
+
+  
+## Test suite
+  
+
+  
+`python setup.py test`
+  
+
+  
+## Contributing
+  
+
+  
+Please see [contributing guidelines](https://github.com/archivesunleashed/au_notebook/blob/master/CONTRIBUTING.md) for details.
+  
+* [Bug reports](https://github.com/archivesunleashed/au_notebook/issues)
+  
+* [Pull requests](https://github.com/archivesunleashed/au_notebook/pulls) are welcome on AUK
+  
+
+  
+## License
+  
+
+  
+Apache 2.0
+  
+
+  
+## Acknowledgments
+  
+
+  
+This work is primarily supported by the [Andrew W. Mellon Foundation](https://uwaterloo.ca/arts/news/multidisciplinary-project-will-help-historians-unlock). Any opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.
diff --git a/aunb.py → au_notebook.py b/aunb.py → au_notebook.py
@@ -14,10 +14,9 @@
 from nltk.sentiment.vader import SentimentIntensityAnalyzer
 from nltk.corpus import stopwords
-  
-
-  
-class AuNotebook():
+  
+class au_notebook():
    """
-  
-    Auk notebook helper functions.
+  
+    Archives Unleashed Notebook helper functions.
    """
    # Maximum number of words to show in output.

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,5 @@
+  
+matplotlib==3.0.2
+  
+networkx==2.2
+  
+nltk==3.4
+  
+numpy==1.15.1
+  
+pandas==0.23.4
diff --git a/setup.py b/setup.py
@@ -0,0 +1,32 @@
+  
+from setuptools import setup
+  
+
+  
+description = \
+  
+    """
+  
+    This module is intended for use with Archives Unleashed Cloud
+  
+    derivative data and the Archives Unleashed Cloud notebooks.
+  
+    For more information, please visit https://archivesunleashed.org/.
+  
+    """
+  
+
+  
+setup(
+  
+    name = 'au_notebook',
+  
+    version = '0.0.1',
+  
+    url = 'https://github.com/archivesunleashed/au_notebook',
+  
+    install_requires=['matplotlib', 'networkx', 'nltk', 'numpy', 'pandas', ],
+  
+    author = 'Ryan Deschamps, Nick Ruest',
+  
+    author_email = 'mjordan@sfu.ca, ruestn@gmail.com',
+  
+    license = 'Apache 2.0',
+  
+    py_modules = ['au_notebook'],
+  
+    scripts = ['au_notebook.py'],
+  
+    description = description,
+  
+    long_description = open('README.md').read(),
+  
+    package_data = { '': ['README.md'] },
+  
+    platforms = ['POSIX'],
+  
+    test_suite = 'test',
+  
+    classifiers = [
+  
+      'License :: Apache 2.0',
+  
+      'Intended Audience :: Developers',
+  
+      'Topic :: Software Development :: Libraries :: Python Modules',
+  
+      'Topic :: Utilities',
+  
+      'Programming Language :: Python :: 3.7',
+  
+    ],
+  
+)
diff --git a/test.py b/test.py
@@ -0,0 +1 @@
+  
+# Test file holder