Skip to content

Commit

Permalink
Settings documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
analog-cbarber committed May 4, 2024
1 parent b07da60 commit f7da3c9
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
23 changes: 23 additions & 0 deletions doc/guide/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,21 @@ to do this download for you, for example:
$ whl2conda convert --from-pypi 'some-package ==1.2.3'
```

The `--from-index` option expects either the full URL of the pypi index to
download from or an alias, which may either be taken from a repository entry
in your [~/.pypirc][pypirc] file or from an entry in the users persistent
whl2conda configuration. For instance, you could register a new index using
a command like:

```bash
$ whl2conda config --set pypi-index.myindex https://myindex.com/pypi/
```
and then convert using:

```bash
$ whl2conda convert --from-index myindex 'some-package'
```

## Building from project directories

If you are creating a conda package for your own python project that uses
Expand Down Expand Up @@ -85,11 +100,19 @@ Reading mypackage-1.2.3-py3-none-any.whl
Writing mypackage-1.2.3-py_0.tar.bz2
```

You can change the default output format through a persistent user setting, .e.g:

```bash
$ whl2conda config --set conda-format V1
```

You can also specify the format `tree` to generate the conda package
as a directory tree, so that you can examine its contents for
debugging purposes.

[pip-download]: https://pip.pypa.io/en/stable/cli/pip_download/
[pip-wheel]: https://pip.pypa.io/en/stable/cli/pip_wheel/
[pypi]: https://pypi.org
[pypirc]: https://packaging.python.org/en/latest/specifications/pypirc/


7 changes: 7 additions & 0 deletions doc/guide/renaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ there is package new to [conda-forge] that may have appeared since installing
$ whl2conda --update-std-renames
```

You can also configure whl2conda to automatically update the standard rename
mappings prior to operations that require via a persistent user setting:

```bash
$ whl2conda config --set auto-update-std-renames true
```

The cache file is kept in a location in your user directory that is specific
to your operating system:

Expand Down

0 comments on commit f7da3c9

Please sign in to comment.