playground4c94/robotodo-tmp

# robotodo
robo-todo, roboto-do

## Installation

<!-- Robotodo may be installed from:
- Source: Run `pip install git+{url}`, where `{url}` is the Git repository URL of robotodo.
For details, see https://pip.pypa.io/en/stable/cli/pip_install/#examples.
- [PyPI](https://pypi.org): Package has not been published yet. -->

Effort to publish to [PyPI](https://pypi.org) is underway.

## Usage

Directory structure:
- `packages`: Package source code.
- `docs`: Documentation and tutorials.
- `examples`: Non-tutorial examples.

Details such as API references
can be found in the `docs` directory.

## Development

- Clone this repository and `cd` into it.
- Run `pip install --editable .`.
- (Optional) Start unit testing:
- Run `pip install --editable .[test]`.
- Run `pytest packages/`.
- (Optional) Build the documentation:
- Run `pip install --editable .[docs]`.
- Run `jupyter-book build docs/`.

Details such as developer guidelines and roadmaps
can be found in the `docs` directory.