Skip to content
/ pvm Public

Project Version Manager (PVM) — A CLI tool for bumping Python project versions following SemVer 2.0.0, with changelog generation and Git integration.

License

Notifications You must be signed in to change notification settings

Statak/pvm

Repository files navigation

Project Version Manager (PVM) 🚀

PVM

Welcome to the Project Version Manager (PVM) repository! PVM is a Command Line Interface (CLI) tool designed to help you manage your Python project versions efficiently. It follows Semantic Versioning 2.0.0 and integrates changelog generation with Git, making version management straightforward and automated.

Table of Contents

Features

  • Version Bumping: Easily bump your project version according to Semantic Versioning.
  • Changelog Generation: Automatically generate a changelog based on your commits.
  • Git Integration: Seamlessly integrate with Git for version tracking.
  • CLI Tool: Simple command-line interface for quick access.
  • Automation: Automate your release process to save time.

Installation

To get started with PVM, you can download the latest release from the Releases section. After downloading, follow these steps:

  1. Download the binary: Choose the appropriate binary for your operating system.
  2. Make it executable: Run the following command in your terminal:
    chmod +x path/to/pvm
  3. Move it to your PATH: You can place the binary in a directory that is in your system's PATH for easy access.

Usage

Using PVM is simple. Here are some common commands:

Bump Version

To bump the version of your project, use the following command:

pvm bump [major|minor|patch]
  • major: Increments the major version.
  • minor: Increments the minor version.
  • patch: Increments the patch version.

Generate Changelog

To generate a changelog, run:

pvm changelog

This command will create a CHANGELOG.md file in your project directory, summarizing the changes since the last release.

Git Integration

PVM integrates with Git to keep track of your changes. Make sure your commits follow a consistent format to help PVM generate accurate changelogs.

Changelog

For a detailed list of changes and updates, please refer to the Releases section.

Contributing

We welcome contributions! If you want to help improve PVM, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your branch to your forked repository.
  5. Create a pull request.

License

PVM is open-source software licensed under the MIT License. See the LICENSE file for more details.

Contact

For questions or feedback, feel free to reach out via GitHub issues or directly through the repository. We appreciate your interest in PVM!


Thank you for using Project Version Manager! We hope it simplifies your version management tasks and enhances your development workflow. Don't forget to check out the Releases section for the latest updates and features!

About

Project Version Manager (PVM) — A CLI tool for bumping Python project versions following SemVer 2.0.0, with changelog generation and Git integration.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •