Python package irelease
Project description
irelease
- irelease is Python package that will help to release your python package on both github and pypi.
A new release of your package is created by taking the following steps:
- Extract the version from the init.py file
- Remove old build directories such as dist, build and x.egg-info
- Git pull (to make sure all is up to date)
- Get latest release version at github
- Check if the local (current) version is newer then the latest github release. a. Make new wheel, build and install package b. Set tag to newest version c. Push to git d. Upload to pypi (credentials for pypi required)
Contents
Installation
- Install irelease from PyPI (recommended). irelease is compatible with Python 3.6+ and runs on Linux, MacOS X and Windows.
- It is distributed under the MIT license.
Quick Start
pip install -r requirements
pip install irelease
Alternatively, install irelease from the GitHub source:
git clone https://github.com/erdogant/irelease.git
cd irelease
python setup.py install
Run irelease
Go to the directory where the package is you want to release and simply run release:
$ release
The following arguments are availble:
# Github name
release -u <githubname>
# Package name your want to release
release -p <packagename>
# Removing local builds:
# 1: Yes
# 0: No
release -c 1
# Verbosity messages:
# 0: No messages
# 1: Error only
# 2: Warnings and above
# 3: Regular messages and above
# 4: Debug and above
# 5: Trace and above
release -v 5
# Twine path for to irelease at pypi. This is automatically determined if standard installation is performed.
release -t 'C://Users/erdogant/AppData/Roaming/Python/Python36/Scripts/twine.exe'
Example:
Your package to-be-published must have the correct structure. At least these files and folders are expected:
<any_dirname>/
├── <package_dir>/
│ ├── __init__.py
│ ├── package_name.py
│ ├── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── ...
Example: releasing bnlearn package.
bnlearn/
├── bnlearn/
│ ├── __init__.py
│ ├── bnlearn.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
Go to your destination dir and run release:
$ release
Run irelease by python script
It is also possible to release the software by running the irelease script. Go to the directory where the package is you want to release and run irelease by:
$ python
>>> import irelease
>>> irelease.make_script()
$ release.sh
Run irelease using by bash script
# Package can be specified:
$ bnlearn>release -p bnlearn
# Username can be specified:
$ bnlearn>release -u erdogant
# Cleaning of previous builds in directory can be disabled
$ bnlearn>release -c 0
You need to do one final edit on github:
Citation
Please cite irelease in your publications if this is useful for your research. Here is an example BibTeX entry:
@misc{erdogant2020irelease,
title={irelease},
author={Erdogan Taskesen},
year={2019},
howpublished={\url{https://github.com/erdogant/irelease}},
}
Maintainers
- Erdogan Taskesen, github: erdogant
Contribute
- Contributions are welcome.
Licence
See LICENSE for details.
Donation
- This work is created and maintained in my free time. Contributions of any kind are appreciated. Sponsering is also possible.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
irelease-0.1.7.tar.gz
(8.3 kB
view hashes)