Skip to content

Commit

Permalink
Merge branch 'main' into develop; bump dev version number to 0.2-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
rlskoeser committed Mar 3, 2023
2 parents 1d7a041 + 1a33060 commit 5ec72aa
Show file tree
Hide file tree
Showing 10 changed files with 121 additions and 84 deletions.
62 changes: 8 additions & 54 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,71 +1,25 @@
{
"projectName": "undate-python",
"projectOwner": "dh-tech",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"commit": true,
"commitConvention": "angular",
"contributors": [
{
"login": "ColeDCrawford",
"name": "Cole Crawford",
"avatar_url": "https://avatars.githubusercontent.com/u/16374762?v=4",
"profile": "https://github.com/ColeDCrawford",
"contributions": [
"code",
"review",
"test"
]
},
{
"login": "rlskoeser",
"name": "Rebecca Sutton Koeser",
"avatar_url": "https://avatars.githubusercontent.com/u/691231?v=4",
"profile": "http://rlskoeser.github.io",
"contributions": [
"code",
"review",
"test"
]
},
{
"login": "robcast",
"name": "Robert Casties",
"avatar_url": "https://avatars.githubusercontent.com/u/1488847?v=4",
"profile": "https://github.com/robcast",
"profile": "http://rlskoeser.github.io/",
"contributions": [
"data"
]
},
{
"login": "jdamerow",
"name": "Julia Damerow",
"avatar_url": "https://avatars.githubusercontent.com/u/8881141?v=4",
"profile": "https://github.com/jdamerow",
"contributions": [
"code",
"review",
"test",
"eventOrganizing"
]
},
{
"login": "maltevogl",
"name": "Malte Vogl",
"avatar_url": "https://avatars.githubusercontent.com/u/20907912?v=4",
"profile": "https://github.com/maltevogl",
"contributions": [
"code",
"review",
"test",
"doc"
"blog"
]
}
],
"contributorsPerLine": 7,
"skipCi": true,
"repoType": "github",
"repoHost": "https://github.com",
"projectName": "hackathon-2022",
"projectOwner": "dh-tech"
"linkToUsage": true
}
39 changes: 39 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload Python Package

on:
release:
types: [published]

permissions:
contents: read

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Build package
run: python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ wheels/
.installed.cfg
*.egg
MANIFEST
docs/_build/

# Environments
.tox
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Change Log

## 0.1

Pre-alpha version with preliminary `Undate` and `UndateInterval` classes
with support for ISO8601 date format
49 changes: 46 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,46 @@
# undate-python
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

**undate** is a python library for working with uncertain or partially known dates.

It was initially created as part of a [DH-Tech](https://dh-tech.github.io/) hackathon in November 2022.

`undate` is a python library for working with uncertain or partially known dates.
---

⚠️ **WARNING:** this is pre-alpha software and is **NOT** feature complete! Use with caution. ⚠️

---

It was initially created as part of a DH-Tech hackathon in November 2022.

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Documentation Status](https://readthedocs.org/projects/undate-python/badge/?version=latest)](https://undate-python.readthedocs.io/en/latest/?badge=latest)
[![unit tests](https://github.com/dh-tech/undate-python/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/dh-tech/undate-python/actions/workflows/unit_tests.yml)
[![codecov](https://codecov.io/gh/dh-tech/undate-python/branch/main/graph/badge.svg?token=GE7HZE8C9D)](https://codecov.io/gh/dh-tech/undate-python)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
<!-- 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 -->

## Documentation

Project documentation is available on ReadTheDocs https://undate-python.readthedocs.io/en/latest/

## 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@main#egg=undate
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):
Expand Down Expand Up @@ -90,6 +110,29 @@ tox -e docs
<!-- 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="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="#blog-rlskoeser" title="Blogposts">📝</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 -->
<table>
<tbody>
<tr>
Expand Down
26 changes: 11 additions & 15 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,30 @@

# -- Project information -----------------------------------------------------

project = 'Undate'
copyright = '2022, DHtech'
author = 'DHtech Community'
project = "Undate"
copyright = "2022, DHtech"
author = "DHtech Community"

# The full version, including alpha/beta/rc tags
release = '0.0.1.dev'
release = "0.0.1.dev"

master_doc = 'index'
master_doc = "index"


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'm2r2'
]
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "m2r2"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

source_suffix = [".rst", ".md"]

Expand All @@ -53,11 +49,11 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]

html_logo = '_static/logo.png'
html_logo = "_static/logo.png"
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Undate documentation
====================

This project ...
**undate** is a python library for working with uncertain or partially known dates.


.. toctree::
Expand Down
17 changes: 8 additions & 9 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[metadata]
name = undate
version = attr: undate.__version__
author = 'DHTech'
author_email = '[email protected]'
description = "library for working with uncertain, fuzzy, or "
+ "partially unknown dates and date intervals"
author = DHTech
author_email = "[email protected]"
description = "library for working with uncertain, fuzzy, or partially unknown dates and date intervals"
long_description = file: README.md
license="Apache License, Version 2.0",
license="Apache License, Version 2.0"
long_description_content_type = text/markdown
url = https://github.com/dh-tech/undate-python
project_urls =
Project Home = https://dh-tech.github.io
Project Home = https://github.com/dh-tech/undate-python
Bug Tracker = https://github.com/dh-tech/undate-python/issues
keywords = "dates dating uncertainty uncertain-dates unknown partially-known digital-humanities"
classifiers =
Development Status :: 2 - Pre-Alpha
Programming Language :: Python :: 3
Expand Down Expand Up @@ -51,6 +51,7 @@ dev =
tox
twine
wheel
build
%(docs)s
test =
pytest>=7.2
Expand Down Expand Up @@ -83,7 +84,6 @@ testpaths =

[testenv]
deps =
{[options.extras_require]test}
-e ./[test]
commands = pytest {posargs}

Expand All @@ -95,7 +95,7 @@ commands =

[testenv:coverage]
deps =
{[options.extras_require]test}
-e ./[test]
commands =
pytest --cov=./ --cov-report=xml

Expand All @@ -105,6 +105,5 @@ description = invoke sphinx-build to build the HTML docs
basepython = python3.10
deps =
-e ./[docs]
{[options.extras_require]docs}
commands = sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" --color -W -bhtml {posargs}
python -c 'import pathlib; print("documentation available under file://\{0\}".format(pathlib.Path(r"{toxworkdir}") / "docs_out" / "index.html"))'
2 changes: 1 addition & 1 deletion src/undate/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.1.0.dev"
__version__ = "0.2.0-dev"
1 change: 0 additions & 1 deletion src/undate/dateformat/iso8601.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@


class ISO8601DateFormat(BaseDateFormat):

# NOTE: do we care about validation? could use regex
# but maybe be permissive, warn if invalid but we can parse

Expand Down

0 comments on commit 5ec72aa

Please sign in to comment.