Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,29 @@ Pre-requisites
==============

If you are using bits directly from git clone, you should make sure
you have `pyyaml` and `argparse` in your python distribution.
you have the dependencies installed. The easiest way to do this is to run::

pip install -e .


For developers
==========

If you want to contribute to bits, you can run the tests with::

pip install -e .[test] # Only needed once
tox

The test suite only runs fully on a Linux system, but there is a reduced suite for macOS, runnable with::

tox -e darwin

You can also run only the unit tests (it's a lot faster than the full suite) with::

pytest

To run the documentation locally, you can use::

pip install -e .[docs]
cd docs
mkdocs serve
10 changes: 10 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ dependencies = [
'boto3<1.36.0',
]

[project.optional-dependencies]
test = [
'tox',
]
docs = [
'mkdocs',
'mkdocs-material',
'mkdocs-redirects',
]

[project.urls]
homepage = 'https://github.com/bitsorg/bits'

Expand Down
Loading