Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #101

Merged
merged 3 commits into from
Jan 8, 2024
Merged

Docs #101

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ else
endif

VERSION_FILE := src/whl2conda/VERSION
VERSION := $(file < $(VERSION_FILE))
VERSION := $(strip $(file < $(VERSION_FILE)))

-include custom.mk

Expand Down
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,27 @@
*whl2conda* is a command line utility to build and test conda packages
generated directly from pure python wheels.

## Features

* **Performance**: because it does not need to create conda environments
for building, this is much faster than solutions involving *conda-build*.

* **Multiple package formats**: can generate both V1 ('.tar.bz2') and V2 ('.conda')
conda package formats. Can also generate a unpacked directory tree for debugging
or additional user customization.
in order to build, this is *much* faster than solutions involving *conda-build*.

* **Dependency renaming**: renames pypi package dependencies to their
corresponding conda name. Automatically renames packages from known
list collected from conda-forge and supports user-specified rename
patterns as well.

* **Project configuration**: project-specific options can be saved in
* **Multiple package formats**: can generate both V1 ('.tar.bz2') and V2 ('.conda')
conda package formats. Can also generate a unpacked directory tree for debugging
or additional user customization.

* **Project configuration**: *whl2conda* project-specific options can be read from
project's `pyproject.toml` file.

* **Install support**: supports installing conda package into a conda
* **Test install support**: supports installing conda package into a conda
environment for testing prior to deployment.

* **Hides pypi dependencies**: if the original pypi dependencies are included in
the python dist-info included in the conda package, this can result in
problems if pip or other python packaging tools are used in the conda environment.
To avoid this, *whl2conda* changes these dependencies to extras.
* **Hides pypi dependencies**: rewrites the original pip/pypi dependencies in the
installed dist-info to avoid [compatibility issues](https://zuzukin.github.io/whl2conda/latest/guide/renaming.html#hide-pip).


## Installation

Expand Down
Loading