-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CLI samples of reserving package name(s) with customized package para…
…meters added
- Loading branch information
Showing
1 changed file
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -91,7 +91,40 @@ reserver --name sample_name1 sample_name2 --token=PYPI_TOKEN --test | |
```console | ||
reserver --name sample_name1 sample_name2 --token=PYPI_TOKEN | ||
``` | ||
|
||
You can customize package parameters (listed below) by passing considered params as JSON file to reserver. | ||
|
||
Customizable package parameters are: (default value is written in front of them) | ||
- description: `This name has been reserved using Reserver` | ||
- author: `Development Team` | ||
- author: `[email protected]` | ||
- url: `https://url.com` | ||
- download url: `https://download_url.com` | ||
- source: `https://github.com/source` | ||
- license: `MIT` | ||
|
||
#### Reserve in test PyPI (test.pypi.org) with custom parameters (all names have same parameters) | ||
Let's assume we want our package parameters to be as below: | ||
```json | ||
// config.json | ||
{ | ||
"description": "PyPI package name reserver", | ||
"author": "Reserver Development Team", | ||
"author_email": "[email protected]", | ||
"url": "https://github.com/openscilab/reserver", | ||
"download_url": "https://github.com/openscilab/reserver/tarball/v0.2", | ||
"source": "https://github.com/source", | ||
"license": "MIT" | ||
} | ||
``` | ||
Then we should pass `config.json` to the `--param` field of Reserver's CLI in order to get things done. | ||
```console | ||
reserver --name sample_name1 sample_name2 --param config.json --token=PYPI_TOKEN --test | ||
``` | ||
#### Reserve in main PyPI (pypi.org) with custom parameters (each name has different parameters) | ||
Similarily, there should be per file, a dedicated JSON file containing associted parameters and then we need to pass them all to `--param` field of Reserver's CLI. | ||
```console | ||
reserver --name sample_name1 sample_name2 --param name1_param.json name2_param.json --token=PYPI_TOKEN --test | ||
``` | ||
## Issues & bug reports | ||
|
||
Just fill an issue and describe it. We'll check it ASAP! or send an email to [[email protected]](mailto:[email protected] "[email protected]"). | ||
|