Metadata-Version: 2.1
Name: workspace-cli
Version: 0.1.0
Summary: Manage interdependent projects in a workspace.
Home-page: https://github.com/jacksmith15/workspace-cli
Author: Jack Smith
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: cookiecutter
Provides-Extra: pipenv
Provides-Extra: poetry
Requires-Dist: click (>=8.0,<9.0)
Requires-Dist: cookiecutter (>=1.7.3,<2.0.0); extra == "cookiecutter"
Requires-Dist: jsonschema (>=4.0.1,<5.0.0)
Requires-Dist: pipenv (>=2021.5.29,<2022.0.0); extra == "pipenv"
Requires-Dist: poetry (>=1.1.11,<2.0.0); extra == "poetry"
Project-URL: Repository, https://github.com/jacksmith15/workspace-cli
Description-Content-Type: text/markdown

# Workspace

**Workspace** streamlines management and adoption of mono-repositories, by providing a wrapper around multi-repo tooling.

It was initially implemented to manage Python projects, but can be extended to interpret other types of projects.

## Documentation

- [Home](./docs/docs/index.md)
    + [Installation](./docs/docs/installation.md)
    + [Configuration](./docs/docs/configuration.md)
    + [Basic usage](./docs/docs/basic-usage.md)
    + [Templates](./docs/docs/templates.md)
    + [Plugins](./docs/docs/plugins.md)
    + [FAQ](./docs/docs/faq.md)


## Development

Install dependencies:

```shell
pyenv shell 3.8.6  # Or other version >= 3.8
pre-commit install  # Configure commit hooks
poetry install  # Install Python dependencies
```

Run tests:

```shell
poetry run inv verify
```

### Todos

- [ ] Experiment with non-Python workspaces
- [ ] More detailed plugin documentation
- [ ] Example workspaces
- [ ] Test output on shells with limited color support
- [ ] Labelling projects
- [ ] Project aliases

## License

This project is distributed under the MIT license.

