Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed May 11, 2023
1 parent 43a1b9d commit 82db6ab
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,23 @@ Tools for the Transport Data Commons
:target: https://codecov.io/gh/transport-data/tools
:alt: Codecov.io test coverage status badge

Installation
============

Install from PyPI using e.g.: ``pip install transport-data``

You will likely also want to:

- Install the `GitHub CLI <https://github.com/cli/cli#installation>`__.
- Clone the `transport-data/registry <https://github.com/transport-data/registry>`__ repository::

$ tdc config set tdc_registry_local /path/for/local/clone
$ tdc registry clone

Usage
=====

- Clone the repository, e.g. ``git clone [email protected]:transport-data/tools.git``.
- In the cloned directory, run ``pip install .`` —this will also install dependencies.
- Use the tools via the command-line interface (CLI)::
Use the tools via the command-line interface (CLI)::

$ tdc --help
Usage: tdc [OPTIONS] COMMAND [ARGS]...
Expand All @@ -33,7 +44,7 @@ Usage
proto TDC prototype debugging.
registry Manipulate the registry repo.

Each subcommand has its own --help.
Each subcommand has its own --help.

Prototype data
--------------
Expand All @@ -48,8 +59,14 @@ Use::
Development
===========

- Python code:
- Install from source:

- Use `black <https://black.rtfd.io>`__.
- Clone the repository, e.g. ``git clone [email protected]:transport-data/tools.git``.
- In the cloned directory, run ``pip install .[tests]`` —this will also install dependencies for development and testing.

- Exchange MaintainableArtefacts between modules.
- Use `Pytest <https://docs.pytest.org>`__: ``pytest``
- Code style and practices:

- Version as ``vYY.M.D`` using the current date.
- Use `black <https://black.rtfd.io>`__.
- Exchange MaintainableArtefacts between modules.

0 comments on commit 82db6ab

Please sign in to comment.