update docs

Changelog.rst

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+1.0 (2021-11-12)
+--------------------
+* fixes to docs/contributing.rst and package level docs for habanero (#89) (#90) thanks @Daniel-Mietchen !
+* fix limit and offset internal handling for `request` and `Request` (#91) thanks @Bubblbu !
+* `content_negotation` throws warning now on 4xx/5xx status code to allow for bad DOIs alongside good DOIS (#92)
+* add example to README for querying `works` by DOI (#93)
+* fail better when json is not returned; try json.loads and catch ValueError (JSONDecodeError is a subclass of ValueError) (#97)
+* funders, journals, members, prefixes, types and works gain `warn` parameter to optionally throw a warning instead of error if a DOI is not found - not found DOI with `warn=True` returns `None` (#69)
+
 0.7.4 (2020-05-29)
 --------------------
 * `query.title` filter is deprecated, use `query.bibliographic` instead (#85)

docs/conduct.rst

@@ -3,26 +3,126 @@
 Contributor Code of Conduct
 ===========================
 
-As contributors and maintainers of this project, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating documentation,
-submitting pull requests or patches, and other activities.
+Our Pledge
+==========
 
-We are committed to making participation in this project a harassment-free experience for
-everyone, regardless of level of experience, gender, gender identity and expression,
-sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-Examples of unacceptable behavior by participants include the use of sexual language or
-imagery, derogatory comments or personal attacks, trolling, public or private harassment,
-insults, or other unprofessional conduct.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-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. Project maintainers who do not follow the Code of Conduct may be removed
-from the project team.
+Our Standards
+=============
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
-opening an issue or contacting one or more of the project maintainers.
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+Enforcement Responsibilities
+============================
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+Scope
+=====
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+Enforcement
+===========
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at myrmecocystus@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+Enforcement Guidelines
+======================
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+Attribution
+===========
+
+This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_,
+version 2.1, available at `<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>`__.
 
-This Code of Conduct is adapted from the Contributor Covenant
-(https://contributor-covenant.org), version 1.0.0, available at
-https://contributor-covenant.org/version/1/0/0/

docs/contributing.rst

@@ -45,11 +45,6 @@ Writing tests
 We're using `pytest` for testing. See the `pytest docs`_ for
 help on contributing to or writing tests.
 
-The Makefile has tasks for testing under python 2 and 3
-
-.. code-block:: shell
-
-    make test
-    make test3
+The Makefile has a task for testing with vcr (using fixtures: `make test`) and without (`make test_no_vcr`)
 
 .. _pytest docs: https://docs.pytest.org/en/stable/

docs/license.rst

@@ -3,7 +3,7 @@
 LICENSE
 =======
 
-Copyright (C) 2019 Scott Chamberlain
+Copyright (C) 2021 Scott Chamberlain
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

habanero/__init__.py

@@ -39,7 +39,7 @@
 """
 
 __title__ = "habanero"
-__version__ = "0.7.6"
+__version__ = "1.0.0"
 __author__ = "Scott Chamberlain"
 __license__ = "MIT"