Merge pull request #64 from coreofscience/rearchitect/make-stuff-more…

…-concrete

Making stuff a little bit more concrete

.github/workflows/pythonpackage.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7]
+        python-version: [3.6, 3.7, 3.8]
 
     steps:
     - uses: actions/checkout@v1
@@ -27,9 +27,6 @@ jobs:
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        flake8 . --count --exit-zero --statistics
     - name: Test with pytest
-      run: |
-        pip install pytest
-        pip install -e .
-        pytest
+      run: python setup.py test

.gitignore

@@ -121,3 +121,4 @@ data/
 
 # json files
 *.json
+.testmondata

.zenodo.json

@@ -1,8 +1,8 @@
 {
     "description": "Translates isi web of knowledge files into python objects.",
     "license": "MIT",
-    "title": "coreofscience/python-wostools: Add citation graph support",
-    "version": "v0.2.0",
+    "title": "coreofscience/python-wostools",
+    "version": "v2.0.0",
     "upload_type": "software",
     "publication_date": "2018-08-13",
     "creators": [
@@ -11,6 +11,11 @@
             "affiliation": "Core of science",
             "name": "Oscar David Arbeláe1ez E."
         },
+        {
+            "orcid": "0000-0002-1249-7128",
+            "affiliation": "Core of science",
+            "name": "Juan David Alzate Cardona"
+        },
         {
             "name": "Daniel Stiven Valencia Hernandez",
             "affiliation": "Core of science"
@@ -20,7 +25,7 @@
     "related_identifiers": [
         {
             "scheme": "url",
-            "identifier": "https://github.com/coreofscience/python-wostools/tree/v1.1.0",
+            "identifier": "https://github.com/coreofscience/python-wostools/tree/v2.0.0",
             "relation": "isSupplementTo"
         },
         {

AUTHORS.md

@@ -0,0 +1,11 @@
+# Credits
+
+## Development Lead
+
+-   Core of Science \<<[email protected]>\>
+
+## Contributors
+
+-   Oscar Arbeláez \<<[email protected]>\>
+-   Juan David Alzate Cardona \<<[email protected]>\>
+-   Daniel Valencia \<<[email protected]>\>

CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at
+<https://github.com/coreofscience/python-wostools/issues>.
+
+If you are reporting a bug, please include:
+
+-   Your operating system name and version.
+-   Any details about your local setup that might be helpful in
+    troubleshooting.
+-   Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with \"bug\"
+and \"help wanted\" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with
+\"enhancement\" and \"help wanted\" is open to whoever wants to
+implement it.
+
+### Write Documentation
+
+Python WoS tools could always use more documentation, whether as part of
+the official Python WoS tools docs, in docstrings, or even on the web in
+blog posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at
+<https://github.com/coreofscience/python-wostools/issues>.
+
+If you are proposing a feature:
+
+-   Explain in detail how it would work.
+-   Keep the scope as narrow as possible, to make it easier to
+    implement.
+-   Remember that this is a volunteer-driven project, and that
+    contributions are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here\'s how to set up [wostools]{.title-ref} for
+local development.
+
+1.  Fork the [wostools]{.title-ref} repo on GitHub.
+
+2.  Clone your fork locally:
+
+    ```bash
+    $ git clone [email protected]:your_name_here/python-wostools.git
+    ```
+
+3.  Install your local copy into a virtualenv. Assuming you have
+    virtualenvwrapper installed, this is how you set up your fork for
+    local development:
+
+    ```bash
+    $ mkvirtualenv wostools
+    $ cd wostools/
+    $ python setup.py develop
+    ```
+
+4.  Create a branch for local development:
+
+    ```bash
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+5.  When you\'re done making changes, check that your changes pass
+    flake8 and the tests, including testing other Python versions with
+    tox:
+
+    ```bash
+    $ flake8 wostools tests
+    $ python setup.py test or py.test
+    $ tox
+    ```
+
+    To get flake8 and tox, just pip install them into your virtualenv.
+
+6.  Commit your changes and push your branch to GitHub:
+
+    ```bash
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7.  Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1.  The pull request should include tests.
+2.  If the pull request adds functionality, the docs should be updated.
+    Put your new functionality into a function with a docstring, and add
+    the feature to the list in README.md.
+3.  The pull request should work for Python 3.6, and for PyPy. Check
+    <https://travis-ci.org/coreofscience/python-wostools/pull_requests>
+    and make sure that the tests pass for all supported Python versions.
+
+## Tips
+
+To run a subset of tests:
+
+```bash
+$ py.test tests.test_wostools
+```
+
+## Deploying
+
+A reminder for the maintainers on how to deploy. Make sure all your
+changes are committed (including an entry in HISTORY.rst). Then run:
+
+```bash
+$ bumpversion patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+```
+
+Travis will then deploy to PyPI if tests pass.

HISTORY.md

@@ -0,0 +1,17 @@
+# History
+
+## 2.0.0 (2020-08-09)
+
+-   Make the article class more concrete
+-   Make collections iterable
+-   Add cached and lazy collections for different use cases
+
+## 0.2.0 (2018-08-12)
+
+-   Add support for all WOS fields.
+-   Add graph building support.
+-   Add a little cli for common tasks.
+
+## 0.1.1 (2018-05-10)
+
+-   First release on PyPI.