Skip to content

Commit

Permalink
Check project (#17)
Browse files Browse the repository at this point in the history
* dev: bump dependencies

* feat(check-project): add new command to check code in a project, using mypy

* docs(check-project): add usage instructions

* feat: bump the minor version - 1.1.0

* fix: copy temporary source code into different folders depending on command

* fix(mypy): from dev-dependency to dependency
  • Loading branch information
DavidVujic authored Dec 26, 2022
1 parent 96edaaf commit 980f2c5
Show file tree
Hide file tree
Showing 14 changed files with 521 additions and 297 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,37 @@
# Poetry Multiproject Plugin

This is a Python `Poetry` plugin, adding the `build-project` command.
This is a Python `Poetry` plugin, adding the `build-project` and `check-project` commands.

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/DavidVujic/poetry-multiproject-plugin/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/DavidVujic/poetry-multiproject-plugin/tree/main)

The command will make it possible to use relative package includes.
The `build-project` command will make it possible to use relative package includes.
This feature is very useful for monorepos and when sharing code between projects.


The `check-project` command is useful to check that dependencies are added properly in a project.
It uses the `MyPy` tool under the hood, and will output any errors from the static type checker.


## Usage
Navigate to the project folder (where the `pyproject.toml` file is).

Build a project:
``` shell
poetry build-project
```

Check the code used in a project:

``` shell
poetry check-project
```

Check the code, with a custom `MyPy` configuration to override the defaults:

``` shell
poetry check-project --config-file <PATH-TO-MYPY.INI-CONFIG-FILE>
```

## Installation
This plugin can be installed according to the official [Poetry docs](https://python-poetry.org/docs/plugins/#using-plugins).

Expand Down
Loading

0 comments on commit 980f2c5

Please sign in to comment.