Skip to main content

simple migration script, migrate pipenv to poetry

Project description

pipenv-poetry-migrate

This is simple migration script, migrate pipenv to poetry.

PyPI - Python Version PyPI - Downloads Test Codecov FOSSA Status

: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]
If the dependency already exists in the poetry dependency and you want to re-migrate it, please use the --re-migrate option. However, if the dependency is removed from pipenv, the poetry dependency is not removed.

$ pipenv-poetry-migrate -f Pipfile -t pyproject.toml --re-migrate

[!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

  1. Fork and clone the repository, and create the development branch.
  2. Run poetry install to setup your develop environment.
  3. Do your code.
  4. Run bash scripts/test.sh to check that your test passed.
  5. Run bash scripts/format.sh and bash scripts/lint.sh to check that you haven't warnings.
  6. Open a PR on GitHub.

Test cases

Test cases are in tests/toml, update Pipfile with additional entries and expect_pyproject.toml with expected output.

:pencil: License

FOSSA Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipenv_poetry_migrate-0.6.2.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

pipenv_poetry_migrate-0.6.2-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file pipenv_poetry_migrate-0.6.2.tar.gz.

File metadata

  • Download URL: pipenv_poetry_migrate-0.6.2.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pipenv_poetry_migrate-0.6.2.tar.gz
Algorithm Hash digest
SHA256 2d2a8fe61dda00e5abe117201158c8cca350247af858f6638ef306a9f06283ca
MD5 bb12ffd7d7f6dfcf188124ba27baf1bf
BLAKE2b-256 25b461ac16347b8cce71213d9da867e222c06a0b392d6b4f77c71f0de7142686

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipenv_poetry_migrate-0.6.2.tar.gz:

Publisher: release.yml on yhino/pipenv-poetry-migrate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pipenv_poetry_migrate-0.6.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pipenv_poetry_migrate-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1103d2857732dada9039c6464efa21d0fc7365942df8e24e1a3f69144124086c
MD5 fd57231c4484635b864f9375be272ffc
BLAKE2b-256 a332e603e950fa4d818356d80c18830c8eea0aceec20c025dff381a2162423c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipenv_poetry_migrate-0.6.2-py3-none-any.whl:

Publisher: release.yml on yhino/pipenv-poetry-migrate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page