https://github.com/professormanhattan/semantic-release-python

A semantic-release plugin for PyPi.org that supports both regular and Poetry projects
https://github.com/professormanhattan/semantic-release-python

mblabs megabytelabs package plugin poetry professormanhattan publish pypi pyproject python python3 semantic semantic-release setupcfg washingtondc

Last synced: 5 months ago
JSON representation

A semantic-release plugin for PyPi.org that supports both regular and Poetry projects

• Host: GitHub
• URL: https://github.com/professormanhattan/semantic-release-python
• Owner: ProfessorManhattan
• License: mit
• Created: 2022-01-21T18:15:08.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T15:10:14.000Z (over 2 years ago)
• Last Synced: 2024-12-02T03:04:55.502Z (5 months ago)
• Topics: mblabs, megabytelabs, package, plugin, poetry, professormanhattan, publish, pypi, pyproject, python, python3, semantic, semantic-release, setupcfg, washingtondc
• Language: Shell
• Homepage: https://megabyte.space
• Size: 14 MB
• Stars: 2
• Watchers: 2
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Codeowners: docs/CODEOWNERS

Awesome Lists containing this project

README

        


  

    

      

    

  





  


Semantic Release Python (with Poetry Support)



  
A plugin created by Megabyte Labs









  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  








  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



> 
**A semantic-release plugin for PyPi.org that supports both regular and Poetry projects**




## Table of Contents

- [Overview](#overview)

- [Requirements](#requirements)

  - [Developer Requirements](#developer-requirements)

- [This Repository (Shared Common)](#this-repository-shared-common)

- [Contributing](#contributing)

- [License](#license)



## Overview

**Semantic Release Python** is a [semantic-release](https://semantic-release.gitbook.io/semantic-release/) plugin that brings support for managing the publication of PyPi packages. It supports traditional Python projects with a `setup.cfg` file and also **supports Poetry projects**.

This plugin requires both Python 3 and a recent version of Node.js to be present. After installing the plugin, a few supporting Python packages will automatically be installed into a `virtualenv` located at `.venv`. Using a virtualenv helps to prevent incompatibilities with your current installed software. Before you run any configuration that contains, you must source the virtualenv by running `. venv/bin/activate` or install the dependencies in this project's `requirements.txt` through other means prior to utilizing the plugin.



## Requirements

If you are simply including this library in your project, all you need is a recent version of Node.js. **[Node.js >14.18.0](repository.project.node)** is sometimes required and is the only version range we actively support. Albeit, it is highly probable that lower versions will work as well depending on the requirements that this project imports.

### Developer Requirements

The following versions of Node.js and Python are required for development:

- **[Node.js >14.18.0](repository.project.node)**

- **[Python >3.10.0](repository.project.python)**

Other versions may work, but only the above versions are supported. Most development dependencies are installed automatically by our `Taskfile.yml` set-up (even Node.js and Python). Run `bash start.sh` to install **[Bodega](https://github.com/ProfessorManhattan/Bodega)** (an improved fork of [go-task](https://github.com/go-task/task)) and run the initialization sequence. The taskfiles will automatically install dependencies as they are needed, based on what development tasks you are running. For more information, check out the [CONTRIBUTING.md](https://github.com/megabyte-labs/semantic-release-python/blob/main/docs/CONTRIBUTING.md) or simply run:

```shell

npm run help

```

`npm run help` will ensure Bodega is installed and then open an interactive dialog where you can explore and learn about various developer commands.



## This Repository (Shared Common)

This repository houses files that propagate downstream to project-specific repositories.



## Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/megabyte-labs/semantic-release-python/issues). If you would like to contribute, please take a look at the [contributing guide](https://github.com/megabyte-labs/semantic-release-python/blob/master/docs/CONTRIBUTING.md).

Sponsorship









Dear Awesome Person,



I create open source projects out of love. Although I have a job, shelter, and as much fast food as I can handle, it would still be pretty cool to be appreciated by the community for something I have spent a lot of time and money on. Please consider sponsoring me! Who knows? Maybe I will be able to quit my job and publish open source full time.



Sincerely,



**_Brian Zalewski_**







  





  





  





## License

Copyright © 2020-2021 [Megabyte LLC](https://megabyte.space). This project is [MIT](https://gitlab.com/megabyte-labs/npm/plugin/semantic-release-python/-/blob/master/LICENSE) licensed.