Merge pull request #81 from dh-tech/feature/readme-cleanup

Reorganize and improve documentation

.all-contributorsrc

@@ -1,6 +1,6 @@
 {
   "files": [
-    "README.md"
+    "CONTRIBUTORS.md"
   ],
   "imageSize": 100,
   "commit": true,

CONTRIBUTING.md

@@ -1,23 +1,29 @@
-# Contributing to Undate - A fuzzy date Python library
-
+# Contributing to undate - a python library for working with uncertain or partially known dates
 
 Hey there!
 
 If you found your way here that probably means you are curious about how to contribute to this project. This is great! We are always looking for new contributors. If you can't find the information you are looking for in this document or anywhere else in the repo, please consider [opening a ticket](https://github.com/dh-tech/undate-python/issues) so we know there is something we need to address.
 
 ## Project Setup
-Instructions on how to set up the project locally and how to run the tests can be found [in the Readme file](README.md).
+Instructions on how to set up the project locally and how to run the tests can be found in [Developer Notes](DEVELOPER_NOTES.md).
 
 ## Submitting Changes
-If you would like to contribute by submitting bug fixes, improvements, or new features, please fork the repository and then make a pull request to our main branch when you are ready. For details see [this description of the Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow).
+If you would like to contribute by submitting bug fixes, improvements, or new features, please fork the repository and then make a pull request to undate **develop** branch when you are ready. For details see [this description of the forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow).
+
+Ideally contributions should include documentation and tests for the proposed changes, but if that is a barrier please let us know when you submit a pull request.
 
 ## Submitting Bug Reports and Feature Requests
 If you find a bug or can think a feature you would really like to see being implemented, you can [create a new issue](https://github.com/dh-tech/undate-python/issues). Please first look through the existing issues, however, to avoid duplication of issues.
 
-If you report a bug, please include any error messages you get and a full description of the steps to reproduce the bug. For new feature requests, please clearly describe the functionality you are looking for and, if applicable, why any existing workflow does not suffice. Please also consider, fixing bugs and implementing new features yourself and submit pull request! :) 
+If you report a bug, please include any error messages you get and a full description of the steps to reproduce the bug. For new feature requests, please clearly describe the functionality you are looking for and, if applicable, why any existing workflow does not suffice. Please also consider fixing bugs and implementing new features yourself and submitting them via pull request! :)
+
+## Submitting Use Cases and Example Data
+We are particularly interested in collecting more use cases and example data where undate would be helpful!
+
+Example data can be added to the [examples/use-cases](examples/use-cases) folder by a pull request. 
 
 ## Getting Help
-The best and recommended way to get help is to join the [DHTech Slack](https://dh-tech.github.io/join/) and ask for help there. Only in cases when this is not feasible at all, you can open a new issue and tag it with "Help Request".  
+The best and recommended way to get help is to join the [DHTech Slack](https://dh-tech.github.io/join/) and ask for help there. Only in cases when this is not feasible at all, you can open a new issue and tag it with "Help Request".
 
 ## DHTech
 This project started during the DHTech 2022 Hackathon. If you do technical work in the digital humanities and are intersted in meeting like-minded people, [consider joining](https://dh-tech.github.io/join/)!

CONTRIBUTORS.md

@@ -0,0 +1,46 @@
+# Contributors
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ColeDCrawford"><img src="https://avatars.githubusercontent.com/u/16374762?v=4?s=100" width="100px;" alt="Cole Crawford"/><br /><sub><b>Cole Crawford</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=ColeDCrawford" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3AColeDCrawford" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=ColeDCrawford" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://rlskoeser.github.io"><img src="https://avatars.githubusercontent.com/u/691231?v=4?s=100" width="100px;" alt="Rebecca Sutton Koeser"/><br /><sub><b>Rebecca Sutton Koeser</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Arlskoeser" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Tests">⚠️</a> <a href="#blog-rlskoeser" title="Blogposts">📝</a> <a href="#example-rlskoeser" title="Examples">💡</a> <a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Documentation">📖</a> <a href="#platform-rlskoeser" title="Packaging/porting to new platform">📦</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/robcast"><img src="https://avatars.githubusercontent.com/u/1488847?v=4?s=100" width="100px;" alt="Robert Casties"/><br /><sub><b>Robert Casties</b></sub></a><br /><a href="#data-robcast" title="Data">🔣</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/jdamerow"><img src="https://avatars.githubusercontent.com/u/8881141?v=4?s=100" width="100px;" alt="Julia Damerow"/><br /><sub><b>Julia Damerow</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Ajdamerow" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Tests">⚠️</a> <a href="#eventOrganizing-jdamerow" title="Event Organizing">📋</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/maltevogl"><img src="https://avatars.githubusercontent.com/u/20907912?v=4?s=100" width="100px;" alt="Malte Vogl"/><br /><sub><b>Malte Vogl</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Amaltevogl" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Tests">⚠️</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Documentation">📖</a></td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+### Related blog posts
+
+- [by Rebecca Sutton Koeser](#blog-rlskoeser)
+  - [Join me for a DHTech hackathon? It’s an un-date!](https://dh-tech.github.io/blog/2023-02-09-hackathon-summary/) 2023-02-09 on DHTech blog 

DEVELOPER_NOTES.md

@@ -0,0 +1,81 @@
+# Developer instructions
+
+Ready to contribute to `undate`? Here are some instructions to get you started.
+
+## Setup
+
+### Use git to checkout a copy of the repository
+```sh
+git clone [email protected]:dh-tech/undate-python.git
+cd undate-python
+```
+
+### Install and initialize git flow
+
+This repository uses [git-flow](https://github.com/nvie/gitflow) branching conventions:
+- **main** will always contain the most recent release
+- **develop** branch is the latest version of work in progress
+
+Pull requests for new features should be made against the **develop** branch.
+
+We recommended installing git-flow.
+1. On OSX, use brew or ports, e.g.: `brew install git-flow`; on Ubuntu/Debian, `apt-get install git-flow`
+2. Initialize it in your local copy of this repository: run `git flow init` and accept all the defaults.  
+3. Use `git flow feature start feature-name` to create a new feature development branch.
+4. Feature branches can be merged locally with git flow or by GitHub pull request.
+4. Use git flow for releases with `git flow release start x.x.x` and `git flow release finish x.x.x`, where x.x.x is the version number for the new release.
+
+If you cannot or prefer not to install git flow, you can do the equivalent manually.
+1. Check out the develop branch: `git checkout develop`
+3. Create new feature manually from the develop branch: `git checkout -b feature/xxx-name`
+
+### Create a Python virtual environment
+
+Use a recent version of python 3. We highly recommend using a python virtualenv, e.g.
+```
+python3 -m venv undate
+source undate/bin/activate
+```
+
+### Install local version of undate with development python dependencies
+
+Install an editable version of the local package along with python dependencies needed for testing and development.
+
+```sh
+pip install -e ".[dev]"
+```
+
+## Install pre-commit hooks
+
+```sh
+pre-commit install
+```
+
+We use [pre-commit](https://pre-commit.com/) for automated checks and consistent formatting.  If you're planning to contribute, please install these when you set up your local development.
+
+## Tests, documentation, and other checks
+
+## Running unit tests
+
+Tests can be run with either `tox` or `pytest`.
+
+To run all the tests in a single test file, use pytest and specify the path to the test: `pytest tests/test_dateformat/test_base.py`
+
+To test cases by name, use pytest: `pytest -k test_str`
+
+## Check python types
+
+Python typing is currently enforced on pull requests as part of a GitHub Actions Continuous Integration check using `mypy`.
+
+To check types locally:
+1. Install the necessary typing libraries (first run only):
+```sh
+mypy --install-types
+```
+2. Run `mypy src/` to check types.
+
+### Documentation can be built with tox
+
+```sh
+tox -e docs
+```

README.md

@@ -1,7 +1,4 @@
 # undate-python
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 **undate** is a python library for working with uncertain or partially known dates.
 
@@ -23,137 +20,14 @@ It was initially created as part of a [DH-Tech](https://dh-tech.github.io/) hack
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
+Read [Contributors](CONTRIBUTORS.md) for detailed contribution information.
+
 ## Documentation
 
 Project documentation is available on ReadTheDocs https://undate-python.readthedocs.io/en/latest/
 
+For instructions on setting up for local development, see [Developer Notes](DEVELOPER_NOTES.md).
+
 ## License
 
 This software is licensed under the [Apache 2.0 License](LICENSE.md).
-
-## Installation
-
-To install the most recent release from PyPI:
-```sh
-pip install undate
-```
-
-To install the latest development version from GitHub:
-```sh
-pip install git+https://github.com/dh-tech/undate-python.git@develop#egg=undate
-```
-
-To install a specific release or branch, run the following (replace `[tag-name]` with the tag or branch you want to install):
-```sh
-pip install git+https://github.com/dh-tech/undate-python.git@[tag-name]
-```
-
-## Instructions to setup for development
-
-### Clone repo
-```
-$ git clone [email protected]:dh-tech/undate-python.git
-cd undate-python
-```
-
-## Setup and initialize git flow
-
-This repository uses [git-flow](https://github.com/nvie/gitflow) branching conventions:
-- **main** will always contain the most recent release
-- **develop** branch is the latest version of work in progress
-
-Pull requests for new features should be made against the **develop** branch.
-
-It is recommended to install git flow (on OSX, use brew or ports, e.g.: `brew install git-flow`; on Ubuntu/Debian, `apt-get install git-flow`) and then initialize it in this repository via `git flow init` and accept the defaults.  Then you can use `git flow feature start` to create feature development branches.
-
-Alternately, you can check out the develop branch (`git checkout develop`)
-and create your branches manually based on develop (`git checkout -b feature/xxx-name`).
-
-### Set up Python environment
-Use a recent version of python 3.x; recommended to use a virtualenv, e.g.
-```
-python3 -m venv undate
-source undate/bin/activate
-```
-
-### Install the package
-
-Install an editable version of the local package along with python dependencies needed for testing and development.
-
-```sh
-pip install -e ".[dev]"
-```
-
-### Install pre-commit hooks
-```sh
-pre-commit install
-```
-
-### Run unit tests
-Tests can be run with either `tox` or `pytest`.
-
-To run all the tests in a single test file, use pytest and specify the path to the test: `pytest tests/test_dateformat/test_base.py`
-
-To test cases by name, use pytest: `pytest -k test_str`
-
-### Check python types
-
-Python typing is currently only enforced by a CI check action using `mypy`.
-To run mypy locally, first install mypy and the necessary typing libraries:
-```sh
-pip install mypy
-mypy --install-types
-```
-
-Once mypy is installed, run `mypy src/` to check.
-
-
-### Create documentation
-
-```sh
-tox -e docs
-```
-
-## Contributors
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tbody>
-    <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ColeDCrawford"><img src="https://avatars.githubusercontent.com/u/16374762?v=4?s=100" width="100px;" alt="Cole Crawford"/><br /><sub><b>Cole Crawford</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=ColeDCrawford" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3AColeDCrawford" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=ColeDCrawford" title="Tests">⚠️</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="http://rlskoeser.github.io"><img src="https://avatars.githubusercontent.com/u/691231?v=4?s=100" width="100px;" alt="Rebecca Sutton Koeser"/><br /><sub><b>Rebecca Sutton Koeser</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Arlskoeser" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Tests">⚠️</a> <a href="#blog-rlskoeser" title="Blogposts">📝</a> <a href="#example-rlskoeser" title="Examples">💡</a> <a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Documentation">📖</a> <a href="#platform-rlskoeser" title="Packaging/porting to new platform">📦</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/robcast"><img src="https://avatars.githubusercontent.com/u/1488847?v=4?s=100" width="100px;" alt="Robert Casties"/><br /><sub><b>Robert Casties</b></sub></a><br /><a href="#data-robcast" title="Data">🔣</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/jdamerow"><img src="https://avatars.githubusercontent.com/u/8881141?v=4?s=100" width="100px;" alt="Julia Damerow"/><br /><sub><b>Julia Damerow</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Ajdamerow" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Tests">⚠️</a> <a href="#eventOrganizing-jdamerow" title="Event Organizing">📋</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/maltevogl"><img src="https://avatars.githubusercontent.com/u/20907912?v=4?s=100" width="100px;" alt="Malte Vogl"/><br /><sub><b>Malte Vogl</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Amaltevogl" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Tests">⚠️</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Documentation">📖</a></td>
-    </tr>
-  </tbody>
-  <tfoot>
-    <tr>
-      <td align="center" size="13px" colspan="7">
-        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
-          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
-        </img>
-      </td>
-    </tr>
-  </tfoot>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-
-### Related blog posts
-
-- [by Rebecca Sutton Koeser](#blog-rlskoeser)
-  - [Join me for a DHTech hackathon? It’s an un-date!](https://dh-tech.github.io/blog/2023-02-09-hackathon-summary/) 2023-02-09 on DHTech blog 

examples/README.md

@@ -0,0 +1,7 @@
+# undate examples
+
+Example data and projects with use cases for uncertain date logic and 
+example code notebooks using undate.
+
+- [use cases](use-cases) - examples from projects or specific data with use cases for undate
+- [notebooks](notebooks) - code notebooks showing how undate can be used on a specific dataset or for a specific problem

setup.cfg

@@ -57,6 +57,7 @@ dev =
   twine
   wheel
   build
+  mypy
   %(docs)s
 test =
   pytest>=7.2