Metadata-Version: 2.1
Name: irelease
Version: 0.1.9
Summary: irelease is an Python package to release your package.
Home-page: https://github.com/erdogant/irelease
Author: Erdogan Taskesen
Author-email: erdogant@gmail.com
License: UNKNOWN
Download-URL: https://github.com/erdogant/irelease/archive/0.1.9.tar.gz
Description: # irelease
        
        [![Python](https://img.shields.io/pypi/pyversions/irelease)](https://img.shields.io/pypi/pyversions/irelease)
        [![PyPI Version](https://img.shields.io/pypi/v/irelease)](https://pypi.org/project/irelease/)
        [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/erdogant/irelease/blob/master/LICENSE)
        [![Downloads](https://pepy.tech/badge/irelease/week)](https://pepy.tech/project/irelease/week)
        [![Donate Bitcoin](https://img.shields.io/badge/donate-grey.svg)](https://erdogant.github.io/donate/?currency=USD&amount=5)
        
        * 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](#-installation)
        - [Requirements](#-Requirements)
        - [Quick Start](#-quick-start)
        - [Contribute](#-contribute)
        - [Citation](#-citation)
        - [Maintainers](#-maintainers)
        - [License](#-copyright)
        
        ### 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
        ```bash
        pip install irelease
        ```
        
        ### Alternatively, install irelease from the GitHub source:
        ```bash
        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:
        ```bash
        $ release
        ```
        
        The following arguments are availble:
        ```bash
        # 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:
        ```bash
            <any_dirname>/
            â”œâ”€â”€ <package_dir>/
            â”‚   â”œâ”€â”€ __init__.py
            â”‚   â”œâ”€â”€ package_name.py
            â”‚   â”œâ”€â”€ ...
            â”œâ”€â”€ .gitignore
            â”œâ”€â”€ LICENSE
            â”œâ”€â”€ README.md
            â”œâ”€â”€ requirements.txt
            â”œâ”€â”€ setup.py
            â””â”€â”€ ...
        ```
        
        
        ### Example: releasing bnlearn package.
        ```bash
            bnlearn/
            â”œâ”€â”€ bnlearn/
            â”‚   â”œâ”€â”€ __init__.py
            â”‚   â”œâ”€â”€ bnlearn.py
            â”œâ”€â”€ .gitignore
            â”œâ”€â”€ LICENSE
            â”œâ”€â”€ README.md
            â”œâ”€â”€ requirements.txt
            â”œâ”€â”€ setup.py
        ```
        <p align="left">
          <img src="https://github.com/erdogant/irelease/blob/master/docs/figs/fig1.png" width="500" />
        </p>
        
        
        #### Go to your destination dir and run release:
        ```bash
        $ release
        ```
        
        **release with your specified arguments**
        ```bash
        # 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
        ```
        
        <p align="left">
          <img src="https://github.com/erdogant/irelease/blob/master/docs/figs/fig2.png" width="600" />
        </p>
        
        
        #### 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:
        ```bash
        $ python
        >>> import irelease
        >>> irelease.make_script()
        $ python release.py
        ```
        
        <p align="left">
          <img src="https://github.com/erdogant/irelease/blob/master/docs/figs/fig2b.png" width="600" />
        </p>
        
        ### Do not forget to enter some release information on github and mark your release number:
        <p align="left">
          <img src="https://github.com/erdogant/irelease/blob/master/docs/figs/fig3.png" width="600" />
          <img src="https://github.com/erdogant/irelease/blob/master/docs/figs/fig4.png" width="600" />
        </p>
        
        
        ### Citation
        Please cite irelease in your publications if this is useful for your research. Here is an example BibTeX entry:
        ```BibTeX
        @misc{erdogant2020irelease,
          title={irelease},
          author={Erdogan Taskesen},
          year={2019},
          howpublished={\url{https://github.com/erdogant/irelease}},
        }
        ```
        
        #### Maintainers
        * Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
        #### Contribute
        * Contributions are welcome.
        #### Licence
        See [LICENSE](LICENSE) for details.
        #### Donation
        * This work is created and maintained in my free time. If you wish to buy me a <a href="https://erdogant.github.io/donate/?currency=USD&amount=5">Coffee</a> for this work, it is very appreciated.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
