From 9fde3d4cd878009217755349ca72e3a2c8f3c3a4 Mon Sep 17 00:00:00 2001 From: Michael Twomey Date: Sun, 7 Nov 2021 18:08:29 +0000 Subject: [PATCH] Preparing for 1.0 release Run `pre-commit autoupdate` Run `pre-commit run -a` across all files Update MANIFEST.in for anyone using setup.py build (not sure if it will be used any more). Update release instructions in README.rst --- .pre-commit-config.yaml | 6 +- .tool-versions | 2 +- MANIFEST.in | 13 +++- README.rst | 22 ++++-- docs/conf.py | 152 ++++++++++++++++++++-------------------- iso8601/test_iso8601.py | 2 +- pyproject.toml | 2 +- 7 files changed, 111 insertions(+), 88 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b6648d4..ca95ebb 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -10,14 +10,14 @@ repos: - id: check-yaml - id: check-added-large-files - repo: https://github.com/pre-commit/mirrors-isort - rev: v5.9.2 + rev: v5.9.3 hooks: - id: isort - repo: https://github.com/psf/black - rev: 21.6b0 + rev: 21.10b0 hooks: - id: black - repo: https://github.com/pre-commit/mirrors-mypy - rev: v0.910 + rev: v0.910-1 hooks: - id: mypy diff --git a/.tool-versions b/.tool-versions index 1d0ae44..4b0f984 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1 +1 @@ -python 3.9.6 3.10.0b3 3.8.7 3.7.9 3.6.12 +python 3.9.6 3.10.0 3.8.7 3.7.9 3.6.12 pypy3.7-7.3.7 diff --git a/MANIFEST.in b/MANIFEST.in index ea47448..2f05190 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,13 @@ recursive-include iso8601 *.py -include README.rst LICENSE tox.ini setup.py *requirements.txt \ No newline at end of file +recursive-include docs * +include .editorconfig +include .envrc +include .gitignore +include .pre-commit-config.yaml +include .tool-versions +include LICENSE +include noxfile.py +include poetry.lock +include pyproject.toml +include README.rst +include setup.py diff --git a/README.rst b/README.rst index 1cf591f..accfbbf 100644 --- a/README.rst +++ b/README.rst @@ -74,15 +74,27 @@ References Testing ======= -1. poetry install -2. poetry run nox +1. `poetry install` +2. `poetry run nox` Note that you need all the pythons installed to perform a tox run (see below). pyenv helps hugely, use pyenv install for the versions you need then use 'pyenv local version ...' to link them in (the tox-pyenv plugin will pick them up). Alternatively, to test only with your current python: -1. poetry install -2. pytest +1. `poetry install` +2. `pytest` + +Releasing +========= + +1. Ensure there is a new version committed to main (use `poetry version ` to bump). +2. Ensure README.rst changelog is up to date. +3. Note new and previous version. +4. `rm -rf dist` +5. `poetry build` +6. `git log --oneline $LAST_RELEASE..@ > git_log.txt` +7. `gh release create --notes-file git_log.txt --title $NEXT_VERSION $NEXT_VERSION dist/*` +8. `poetry publish` Supported Python Versions ========================= @@ -93,7 +105,7 @@ Tested against: - Python 3.7 - Python 3.8 - Python 3.9 -- Python 3.10 (pre-release) +- Python 3.10 - PyPy 3 Python 3 versions < 3.6 are untested but should work. diff --git a/docs/conf.py b/docs/conf.py index e69f768..2aa97b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,233 +13,227 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys import os +import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # 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.doctest', - 'sphinx.ext.viewcode', + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.viewcode", ] # doctest configuration doctest_path = [os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'pyiso8601' -copyright = '2014, Michael Twomey' +project = "pyiso8601" +copyright = "2014, Michael Twomey" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.1.10' +version = "0.1.10" # The full version, including alpha/beta/rc tags. -release = '0.1.10' +release = "0.1.10" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ["_build"] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = "default" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # 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"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'pyiso8601doc' +htmlhelp_basename = "pyiso8601doc" # -- Options for LaTeX output --------------------------------------------- -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', +latex_elements = { # type: ignore + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'pyiso8601.tex', 'pyiso8601 Documentation', - 'Michael Twomey', 'manual'), + ("index", "pyiso8601.tex", "pyiso8601 Documentation", "Michael Twomey", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'pyiso8601', 'pyiso8601 Documentation', - ['Michael Twomey'], 1) -] +man_pages = [("index", "pyiso8601", "pyiso8601 Documentation", ["Michael Twomey"], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -248,19 +242,25 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'pyiso8601', 'pyiso8601 Documentation', - 'Michael Twomey', 'pyiso8601', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "pyiso8601", + "pyiso8601 Documentation", + "Michael Twomey", + "pyiso8601", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/iso8601/test_iso8601.py b/iso8601/test_iso8601.py index 666a382..586e7a9 100644 --- a/iso8601/test_iso8601.py +++ b/iso8601/test_iso8601.py @@ -6,8 +6,8 @@ import pickle import hypothesis -import hypothesis.strategies import hypothesis.extra.pytz +import hypothesis.strategies import pytest from . import iso8601 diff --git a/pyproject.toml b/pyproject.toml index 42d4e68..61e7fd2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "iso8601" -version = "1.0.0-alpha.1" +version = "1.0.0-alpha.2" description = "Simple module to parse ISO 8601 dates" authors = ["Michael Twomey "] license = "MIT"