Skip to main content

Extracts the version from a Python file

Project description

A tool for extracting the version of a Python file.

Version extractor Pypi package page Version extractor latest documentation Status Version extractor development documentation Status

Features

  • Extract the value from a version field inside any Python file

Documentation

Documentation sources are included with the project, and used to generate the documentation sites:

  • The latest docs are always generated for the latest release, kept in the ‘master’ branch

  • The development docs are generated from the latest code in the ‘develop’ branch

You can also create the documentation from the source files, kept in the ‘docs’ folder, with the help of Sphinx. For this use the makefile, or the make.bat file, contained on that folder.

Prerequisites

The project has been tested in the following versions of the interpreter:

  • Python 3.4

  • Python 3.5

  • Python 3.6

  • Pypy 3

All other dependencies are indicated on the requirements.txt file.

These can be installed with:

$ pip install --upgrade -r requirements.txt

Installing

The project is offered as a Pypi package, and using pip is the preferred way to install it. For this use the following command;

$ pip install bernardomg.version-extractor

If needed, manual installation is possible:

$ python setup.py install

Usage

Just import and use the function:

from version_extractor import extract_version

version = extract_version('tests/resources/__init__.py')

Or use a preconfigured function:

from version_extractor import extract_version_init

version = extract_version_init('tests/resources')

This is useful when setting up a setup.py file:

setup(
    ...
    version=extract_version_init(_source_package),
    ...
)

Testing

The tests included with the project can be run with:

$ python setup.py test

This will delegate the execution to tox.

It is possible to run just one of the test profiles, in this case the py36 profile:

$ python setup.py test -p "py36"

Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

  • Reporting errors and asking for extensions through the issues management

  • or forking the repository and extending the project

Issues management

Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.

Getting the code

If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the ‘master’ branch for the latest release, and the ‘develop’ for the current, and stable, development version.

License

The project has been released under the MIT License.

Project details


Download files

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

Source Distribution

bernardomg.version_extractor-1.1.0.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

bernardomg.version_extractor-1.1.0-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file bernardomg.version_extractor-1.1.0.tar.gz.

File metadata

  • Download URL: bernardomg.version_extractor-1.1.0.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for bernardomg.version_extractor-1.1.0.tar.gz
Algorithm Hash digest
SHA256 799897db01bf7421c87214f2a9b167499e7c54f2df5f64b377ebc987a63530ec
MD5 7bb376b63e071dc34c737b8e2cc9d871
BLAKE2b-256 a28af35d2adcef34bb19278e6f718799d3263f2097d80c3a13bc50583f64b8be

See more details on using hashes here.

File details

Details for the file bernardomg.version_extractor-1.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: bernardomg.version_extractor-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for bernardomg.version_extractor-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9377d5ecced43ccdb6b02f5c030da605ad62f742f592133e5a040b9a741df48e
MD5 15fb4852ba8807d754f9258a56d12c40
BLAKE2b-256 0be012695df9a5c13b578a361b2af80034a3688be8023d4e7ad3fc02f7814242

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page