reserver 0.3

Description:

reserver 0.3

Disclaimer
⚠️ Warning ⚠️

The intention of this package is facilitating the reservation of package names on PyPI for legitimate and appropriate purposes. We explicitly disclaim any responsibility for the misuse or spamming of this tool, particularly in the excessive reservation of package names. Users are advised to be cautious and ensure the legitimate use of this package to avoid potential consequences such as the suspension of their PyPI account. By using this package, users acknowledge and agree to these terms.

Overview

Reserver is an open source Python package that offers the ability to quickly reserve a PyPI package name. Got a notion? Before it's taken, immediately reserve the product name!



PyPI Counter







Github Stars









Branch
main
dev


CI








Installation
PyPI

Check Python Packaging User Guide
Run pip install reserver==0.3

Source code

Download Version 0.3 or Latest Source
Run pip install .

Usage
Programmatically
Reserve a package name in main PyPI (pypi.org)
from reserver import PyPIUploader
uploader = PyPIUploader(PYPI_TOKEN, test_pypi=False)
uploader.upload("CONSIDERED_NAME_FOR_YOUR_PACKAGE")

Reserve batch of names with custom user-defined parameters in test PyPI (test.pypi.org)
uploader = PyPIUploader(TEST_PYPI_TOKEN, test_pypi=True)
uploader.batch_upload(["PACKAGE_NAME_1", "PACKAGE_NAME_2"], ["config1.json", "config2.json"])

CLI
⚠️ You can use reserver or python -m reserver to run this program
Version
reserver -v
reserver --version

Reserve in test PyPI (test.pypi.org)
reserver --name sample_name1 sample_name2 --token=TEST_PYPI_TOKEN --test

Reserve in main PyPI (pypi.org)
reserver --name sample_name1 sample_name2 --token=PYPI_TOKEN

Customizing package parameters
You can customize the following package parameters for reservations on PyPI using the Reserver CLI. The details and defaults are provided in the table below.



Parameter
Type
Default
Description




description
string
This name has been reserved using Reserver
A short description of your PyPI package name reservation.


author
string
Development Team
The name of the author or development team.


author_email
email address
[email protected]
An email address for contact.


url
web address
https://url.com
The project's main repository URL.


download_url
web address
https://download_url.com
The download URL for the package.


source
web address
https://github.com/source
The source code repository URL.


license
string
MIT
The license under which your package is distributed.



There are two ways to define these custom parameters:
1. Single param.json for all packages:
This approach uses a single JSON file (param.json) to define common parameters for all packages. This file could hold information like those described in the table.
Here's how to use this method:
reserver --name sample_name1 sample_name2 --param config.json --token=PYPI_TOKEN

2. Dedicated param.json per package:
This approach allows for more customization by having a separate JSON file for each package. Each file would contain parameters specific to that particular package.
Here's how this method works:
reserver --name sample_name1 sample_name2 --param name1_param.json name2_param.json --token=PYPI_TOKEN

Choose the method that best suits your needs. Using a single param.json is efficient for packages with similar information, while separate files offer more granular control.
⚠️ You can use all available features on both pypi.org and test.pypi.org.
Issues & bug reports
Just fill an issue and describe it. We'll check it ASAP! or send an email to [email protected].

Please complete the issue template

You can also join our discord server

Show your support
Star this repo
Give a ⭐️ if this project helped you!
Donate to our project
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .

Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Unreleased
Added
Changed
0.3 - 2024-08-28
Added

CLI tests added
param arg in CLI Handler
more testcases in conflict cases
batch_upload tests
read_json method in util.py

Changed

README.md updated
upload method in reserver_obj.py
batch_upload method reserver_obj.py

0.2 - 2024-06-17
Added

CLI handler
Python 3.6 support
has_named_parameter method in util.py
feature_request.yml template
config.yml for issue template
batch_upload method in PyPIUploader
SECURITY.md

Changed

upload method in reserver_obj.py
does_package_exist method in reserver_func.py
test.yml for Python 3.6 support
Logo updated
Bug report template modified
Uploader changed to PyPIUploader
README.md modified

0.1 - 2024-02-07
Added

Uploader class
Check package name existence
Upload template package to test PyPI
Upload template package to PyPI
Generate template package for a given name
Handle similar name existence in PyPI
Handle issue with "-" character .egginfo file name