Skip to content
This repository has been archived by the owner on Dec 18, 2022. It is now read-only.

Commit

Permalink
Merge pull request #20 from MousaZeidBaker/readme
Browse files Browse the repository at this point in the history
update README
  • Loading branch information
MousaZeidBaker authored Nov 9, 2021
2 parents 479622f + 3f12d63 commit f7ad640
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@
[![pypi_v](https://img.shields.io/pypi/v/poetryup.svg)](https://pypi.org/project/poetryup)
[![pypi_dm](https://img.shields.io/pypi/dm/poetryup.svg)](https://pypi.org/project/poetryup)

PoetryUp updates dependencies and bumps their version in the `pyproject.toml` file with respect to their version
constraint. The `poetry.lock` file will be recreated as well. PoetryUp runs
[poetry](https://github.com/python-poetry/poetry) commands, thus it's required to be installed. The difference between
running `poetry update` and `poetryup`, is that the latter also modifies the `pyproject.toml` file.
PoetryUp updates dependencies and bumps their version in the `pyproject.toml`
file with respect to their version constraint. The `poetry.lock` file will be
recreated as well. PoetryUp runs
[poetry](https://github.com/python-poetry/poetry) commands, thus it's required
to be installed. The difference between running `poetry update` and `poetryup`,
is that the latter also modifies the `pyproject.toml` file.

![poetryup_demo](https://raw.githubusercontent.com/MousaZeidBaker/poetryup/master/media/poetryup_demo.gif)

Expand All @@ -19,17 +21,13 @@ running `poetry update` and `poetryup`, is that the latter also modifies the `py
poetryup
```

Run tests
```shell
pytest tests
```

## Contributing
Contributions are welcome via pull requests.

## Issues
If you encounter any problems, please file an [issue](https://github.com/MousaZeidBaker/poetryup/issues) along with a
detailed description.
If you encounter any problems, please file an
[issue](https://github.com/MousaZeidBaker/poetryup/issues) along with a detailed
description.

## Develop
Activate virtual environment
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "poetryup"
version = "0.3.14"
version = "0.3.15"
description = "Update dependencies and bump their version in the pyproject.toml file"
authors = ["Mousa Zeid Baker"]
packages = [
Expand Down

0 comments on commit f7ad640

Please sign in to comment.