Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/charbonnierg/repo
Example Python monorepo
https://github.com/charbonnierg/repo
Last synced: about 2 months ago
JSON representation
Example Python monorepo
- Host: GitHub
- URL: https://github.com/charbonnierg/repo
- Owner: charbonnierg
- Created: 2021-04-07T07:11:42.000Z (almost 4 years ago)
- Default Branch: next
- Last Pushed: 2021-04-08T07:57:24.000Z (almost 4 years ago)
- Last Synced: 2023-03-06T03:36:05.712Z (almost 2 years ago)
- Language: Python
- Size: 166 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Python Monorepo
This repository contains a tool to manage python mono repo easily using `poetry` and `git`.
It can host several python packages, which can be built and distributed independently from each other.
## Prerequisites
This repository leverages [`poetry`](https://python-poetry.org/docs/basic-usage/), a python dependency management tool in order to install and build all packages.
Make sure you have [`poetry`](https://python-poetry.org/docs/) installed before going further.
> Note: You can install poetry following the [official documentation](https://python-poetry.org/docs/#installation).
To make sure that you're ready, open a terminal, and type the command:
```bash
poetry --version
```
> Warning: Never install `poetry` using `pip` as it will break your environment !
Once you've got `poetry` installed, make sure it is configured to **NOT** create virtual environments:
```bash
poetry config virtualenvs.create false
```
## Installing all packages
A convenience script can be used to install all dependencies in one go:
```bash
# Clone the repo
git clone https://github.com/charbonnierg/samples.git
# Go into the root directory of the repo
cd samples
# Create your virtual environment
./scripts/boootstrap.sh
```
The development package comes with a Command Line Application that is useful to develop other librairies or applications.
Run the `repo` command to learm more about its features:
```bash
repo --help
```
### Installing the packages for development
In order to install all packages, run the following command:
```bash
repo install
```
### Running the tests
Tests are ran using `pytest` using the following command:
```bash
repo test
```
> Note: You can optionnally specify pytest markers: `repo test -m "databases"` or `repo test -m "not databases"` for example.
### Linting the code
Code is linted using `flake8` using the following command:
```bash
repo lint
```
### Formatting the code
Code is formatted using `black` using the following command:
```bash
repo format
```
### Adding a new package
In order to add a new package, use the `repo` tool:
- In order to create a library:
```bash
repo new library my-library
```
- In order to create a plugin:
```bash
repo new plugin my-plugin
```
- In order to create an application:
```bash
repo new application my-app
```