Skip to content

Commit

Permalink
Add/fix links and adjust commands in README; update version and depen…
Browse files Browse the repository at this point in the history
…dencies.
  • Loading branch information
lapets committed Dec 19, 2021
1 parent 2f55290 commit 6220ae9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This embedded domain-specific language (DSL) makes it possible to write an algor

Package Installation and Usage
------------------------------
The package is available on PyPI::
The package is available on `PyPI <https://pypi.org/project/circuitry/>`_::

python -m pip install circuitry

Expand All @@ -51,19 +51,21 @@ Testing and Conventions
-----------------------
All unit tests are executed and their coverage is measured when using `nose <https://nose.readthedocs.io/>`_ (see ``setup.cfg`` for configution details)::

nosetests
python -m pip install nose coverage
nosetests --cover-erase

Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`_::

python circuitry/circuitry.py -v

Style conventions are enforced using `Pylint <https://www.pylint.org/>`_::

python -m pip install pylint
pylint circuitry

Contributions
-------------
In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/nthparty/circuitry>`_ for this library.

Versioning
----------
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

# The lines below can be parsed by `docs/conf.py`.
name = "circuitry"
version = "0.2.0"
version = "0.3.0"

setup(
name=name,
version=version,
packages=["circuitry",],
install_requires=["parts>=1.0.2","circuit>=0.3.1",],
packages=[name,],
install_requires=["parts~=1.2","circuit~=0.4",],
license="MIT",
url="https://github.com/nthparty/circuitry",
author="Andrei Lapets",
Expand Down

0 comments on commit 6220ae9

Please sign in to comment.