Skip to content

Commit

Permalink
Merge pull request #6 from todofixthis/develop
Browse files Browse the repository at this point in the history
ClassRegistry v4.0.5
  • Loading branch information
todofixthis authored Feb 3, 2023
2 parents 1805a9f + c9fe96e commit 9c7fc21
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 8 deletions.
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
include LICENCE.txt
recursive-include test *.py
graft test
prune **/__pycache__
17 changes: 11 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. image:: https://travis-ci.org/todofixthis/class-registry.svg?branch=master
:target: https://travis-ci.org/todofixthis/class-registry
.. image:: https://readthedocs.org/projects/class-registry/badge/?version=latest
:target: http://class-registry.readthedocs.io/

Expand Down Expand Up @@ -74,8 +72,10 @@ ClassRegistry is known to be compatible with the following Python versions:
- 3.9

.. note::
ClassRegistry's code is pretty simple, so it's likely to be compatible with
versions not listed here; there's just no test coverage to prove it 😇
I'm only one person, so to keep from getting overwhelmed, I'm only committing
to supporting the 3 most recent versions of Python. ClassRegistry's code is
pretty simple, so it's likely to be compatible with versions not listed here;
there just won't be any test coverage to prove it 😇

Installation
------------
Expand All @@ -87,15 +87,20 @@ Install the latest stable version via pip::
.. important::
Make sure to install `phx-class-registry`, **not** `class-registry`. I
created the latter at a previous job years ago, and after I left they never
touched that project again — so in the end I had to fork it 🤷
touched that project again and stopped responding to my emails — so in the
end I had to fork it 🤷

Running Unit Tests
------------------
Install the package with the ``test-runner`` extra to set up the necessary
dependencies, and then you can run the tests with the ``tox`` command::

pip install -e .[test-runner]
tox -p all
tox -p

To run tests in the current virtualenv::

python -m unittest

Documentation
-------------
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[project]
name = "phx-class-registry"
version = "4.0.4"
version = "4.0.5"
description = "Factory+Registry pattern for Python classes"
readme = "README.rst"
requires-python = ">= 3"
Expand Down Expand Up @@ -35,4 +35,5 @@ classifiers = [
[project.urls]
Documentation = "https://class-registry.readthedocs.io/"
Changelog = "https://github.com/todofixthis/class-registry/releases"
Issues = "https://github.com/todofixthis/class-registry/issues"
Repository = "https://github.com/todofixthis/class-registry"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
[tox]
envlist = py3{11,10,9}

[testenv]
commands = python -m unittest

0 comments on commit 9c7fc21

Please sign in to comment.