Skip to main content

Python package irelease

Project description

irelease

Python PyPI Version License Downloads Donate Bitcoin

  • 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:
    1. Extract the version from the init.py file
    2. Remove old build directories such as dist, build and x.egg-info
    3. Git pull (to make sure all is up to date)
    4. Get latest release version at github
    5. 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

Arguments or irelease

Go to the directory where the package is you want to release and run irelease by:

$ python irelease.py

The following arguments are availble:

# Github name
irelease -u <githubname>

# Package name your want to release
irelease -p <packagename>

# Removing local builds:
# 1: Yes
# 0: No
irelease -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
irelease -v 5

# Twine path for to irelease at pypi. This is automatically determined if standard installation is performed.
irelease -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
    └── ...
  • To release your package you can generate a release.py and bash file and run it.
# 1. Go into your package directory
# 2. start ptyhon
# 3. Import irelease, run irelease.make_script()
# 4. A new file (release.sh) is created in your package directory.
# 5. Run it.

# $ python
import irelease
irelease.make_script()
exit()
$ python release.py
or
$ release.sh

Example: releasing bnlearn package.

    bnlearn/
    ├── bnlearn/
    │   ├── __init__.py
    │   ├── bnlearn.py
    ├── .gitignore
    ├── LICENSE
    ├── README.md
    ├── requirements.txt
    ├── setup.py

  • Option 1: Create release bash file and run.
$ python
>>> import irelease
>>> irelease.make_script()
$ release.sh
  • Option 2: Run python file.
$ bnlearn>python C:\Users\Erdogan\Miniconda3\envs\env_TEST\Lib\site-packages\irelease\irelease.py
# Package can be specified:
$ \bnlearn>python irelease -p bnlearn

# Username can be specified:
$ bnlearn>python irelease.py -u erdogant

# Cleaning of previous builds in directory can be disabled
$ bnlearn>python irelease.py -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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for irelease, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size irelease-0.1.6-py3-none-any.whl (9.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size irelease-0.1.6.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page