simple migration script, migrate pipenv to poetry
Project description
pipenv-poetry-migrate
This is simple migration script, migrate pipenv to poetry.
:rocket: Get Started
Installation
$ pip install -U poetry pipenv-poetry-migrate
Migration
Step 1: Create pyproject.toml
file
$ poetry init
Step 2: Migrate
To migrate Pipfile
to pyproject.toml
.
$ pipenv-poetry-migrate -f Pipfile -t pyproject.toml
When want to run dry-run mode:
$ pipenv-poetry-migrate -f Pipfile -t pyproject.toml -n
Dry-run mode is pyproject.toml
file does not overwrite, results are displayed on standard output.
Note: The default behavior is to migrate with the group notation, which has been available since Poetry 1.2.0. If you want to migrate with
dev-dependencies
notation, please use the--on-use-group-notation
option.$ pipenv-poetry-migrate -f Pipfile -t pyproject.toml --no-use-group-notation
Step 3: Generate lock file
$ poetry lock
If there is already a poetry.lock
file, remove it first.
Step 4: Installing dependencies
To install the defined dependencies for your project.
$ poetry install
Example output
This is an example of a Pipfile to be migrated.
[[source]]
url = "https://pypi.python.org/simple"
verify_ssl = true
name = "pypi"
[packages]
requests = "*"
[dev-packages]
pytest = "^5.2"
Migrate the above file to the following pyproject.toml.
[tool.poetry]
name = "migration-sample"
version = "0.1.0"
description = ""
authors = ["Yoshiyuki HINO <yhinoz@gmail.com>"]
[tool.poetry.dependencies]
python = "^3.7"
[tool.poetry.group.dev.dependencies]
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
By executing this script, pyproject.toml is rewritten as follows.
[tool.poetry]
name = "migration-sample"
version = "0.1.0"
description = ""
authors = ["Yoshiyuki HINO <yhinoz@gmail.com>"]
[tool.poetry.dependencies]
python = "^3.7"
requests = "*"
[tool.poetry.group.dev.dependencies]
pytest = "^5.2"
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
:handshake: Contributing
To run tests:
poetry install
# get environment setupmake test
# run the tests
Test cases are in tests/toml
, update Pipfile
with additional entries and expect_pyproject.toml
with expected output
:pencil: License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pipenv_poetry_migrate-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30496992222c456114ad3ec4d4db1fdfc5db75aef61749df32f76067b602df1e |
|
MD5 | 6121ea850267f3ee11ae18e9f3bff4b0 |
|
BLAKE2b-256 | 881c4f32200a982e451f759232512c288c101843b8107add79758c729bee9dbb |
Hashes for pipenv_poetry_migrate-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56c2647d6d535903ede855d752c9d73e989e57f836c2043f6f1b0102f019c4da |
|
MD5 | 68c857c5e14185089f48b19b85578fec |
|
BLAKE2b-256 | 5c7c73bf1315d4250c47de5e2f4ccd79394e7c18e8eca8a43058e8e6f212ce24 |