Merge branch 'docs'

CONTRIBUTING.md

@@ -10,13 +10,14 @@ received a response in a timely manner, please reach out on the Code Shelter cha
 [projects/requests-cache](https://codeshelter.zulipchat.com/#narrow/stream/186993-projects/topic/requests-cache).
 
 ## Development Status
-While the original author no longer has time to work on requests-cache
-([see note here](https://github.com/reclosedev/requests-cache/blob/master/CODESHELTER.md)),
-one or more maintainers are available via [Code Shelter](https://www.codeshelter.co) to help keep
-this project going.
-
-If there is a new feature you would like to see, the best way to make that happen is to submit a PR
-for it!
+Requests-cache is under active development! While the original author no longer has time to work on
+requests-cache ([see note
+here](https://requests-cache.readthedocs.io/en/latest/project_info/codeshelter.md)), maintainers are
+available via [Code Shelter](https://www.codeshelter.co) to help keep this project going.
+
+Contributions are very welcome, and will be attributed on the
+[Contributors](https://requests-cache.readthedocs.io/en/latest/project_info/contributors.html)
+page.
 
 ## Pre-release Installation
 If you want to test out the latest in-development changes, you can install pre-release versions:

README.md

@@ -75,7 +75,7 @@ for i in range(60):
 With caching, the response will be fetched once, saved to `demo_cache.sqlite`, and subsequent
 requests will return the cached response near-instantly.
 
-**Patch it:**
+**Patching:**
 
 If you don't want to manage a session object, or just want to quickly test it out in your
 application without modifying any code, requests-cache can also be installed globally, and all
@@ -88,7 +88,7 @@ requests_cache.install_cache('demo_cache')
 requests.get('http://httpbin.org/delay/1')
 ```
 
-**Customize it:**
+**Configuration:**
 
 A quick example of some of the options available:
 ```python
@@ -114,6 +114,7 @@ To find out more about what you can do with requests-cache, see:
 
 * [User Guide](https://requests-cache.readthedocs.io/en/stable/user_guide.html)
 * [API Reference](https://requests-cache.readthedocs.io/en/stable/reference.html)
+* [Project Info](https://requests-cache.readthedocs.io/en/latest/project_info.html)
 * A working example at Real Python:
   [Caching External API Requests](https://realpython.com/blog/python/caching-external-api-requests)
 * More examples in the

docs/project_info/code_of_conduct.md

@@ -1,4 +1,66 @@
 # {fa}`handshake` Code of Conduct
-```{include} ../../.github/CODE_OF_CONDUCT.md
-:start-line: 1
-```
+This Code of Conduct is adapted from
+[Contributor Covenant, version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
+
+## TL;DR
+Human interaction is both more difficult and more important than software development.
+Please be civil and friendly to each other.
+
+## Our Pledge
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers
+pledge to make participation in our project and our community a harassment-free experience for
+everyone, regardless of age, body size, favorite editor, disability, ethnicity, sex characteristics,
+gender identity and expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+## 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 within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+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 nicolas@niconoe.eu. 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.

CODESHELTER.md → docs/project_info/codeshelter.md

@@ -15,3 +15,5 @@ I have already added Code Shelter to the project's PyPI page, so feel free to
 make any releases necessary.
 
 Thank you!
+
+– Roman Haritonov

docs/project_info/contributing.md

@@ -3,3 +3,9 @@
 ```{include} ../../CONTRIBUTING.md
 :start-line: 1
 ```
+
+```{toctree}
+:hidden:
+
+codeshelter
+```

docs/project_info/related_projects.md

@@ -12,8 +12,8 @@ You can also check out these other python projects related to caching and/or HTT
   file-based cache built on SQLite
 
 ## Async
-* [aiohttp-client-cache](https://github.com/JWCook/aiohttp-client-cache): An async HTTP cache for
-  `aiohttp`, based on `requests-cache`
+* [aiohttp-client-cache](https://github.com/JWCook/aiohttp-client-cache): A client-side async cache
+  for `aiohttp`, based on `requests-cache`
 * [aiohttp-cache](https://github.com/cr0hn/aiohttp-cache): A server-side async HTTP cache for the
   `aiohttp` web server
 * [aiocache](https://github.com/aio-libs/aiocache): General-purpose (not HTTP-specific) async cache
@@ -26,9 +26,11 @@ You can also check out these other python projects related to caching and/or HTT
 ## Testing
 * [requests-mock](https://github.com/jamielennox/requests-mock): A `requests` transport adapter that
   mocks HTTP responses
-* [responses](https://github.com/getsentry/responses): A utility for mocking out the `requests` library
+* [responses](https://github.com/getsentry/responses): A utility for mocking out the `requests`
+  library
 * [vcrpy](https://github.com/kevin1024/vcrpy): Records responses to local files and plays them back
-  for tests; inspired by Ruby's [VCR](https://github.com/vcr/vcr)]. Works at the `httplib` level and
+  for tests; inspired by Ruby's [VCR](https://github.com/vcr/vcr). Works at the `httplib` level and
   is compatible with multiple HTTP libraries.
-* [betamax](https://github.com/betamaxpy/betamax): Records responses to local files and plays them back
-  for tests; also inspired by Ruby's [VCR](https://github.com/vcr/vcr). Made specifically for `requests`.
+* [betamax](https://github.com/betamaxpy/betamax): Records responses to local files and plays them
+  back for tests; also inspired by Ruby's [VCR](https://github.com/vcr/vcr). Made specifically for
+  `requests`.