Metadata-Version: 2.1
Name: pyreptasks
Version: 2.0.1
Summary: This Python library provides the user with some tools useful to automate coding of repetitive tasks
Home-page: https://github.com/tsenovilla/pyreptasks
Author: Tomás Senovilla Polo
Author-email: Tomas Senovilla Polo <tspscgs@gmail.com>
License: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

![PyPI](https://img.shields.io/pypi/v/pyreptasks)
[![CI](https://github.com/tsenovilla/pyreptasks/actions/workflows/ci.yaml/badge.svg)](https://github.com/tsenovilla/pyreptasks/actions/workflows/ci.yaml)
[![pre-commit](https://github.com/tsenovilla/pyreptasks/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/tsenovilla/pyreptasks/actions/workflows/pre-commit.yaml)
![Codecov](https://img.shields.io/codecov/c/gh/tsenovilla/pyreptasks)
![GitHub](https://img.shields.io/github/license/tsenovilla/pyreptasks)
![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/tsenovilla/pyreptasks)


Description
===========

This Python library provides the user with some tools useful to automate coding of repetitive tasks.

Installation and usage
======================

To install this package use : pip install pyreptasks

There is not need of other Python packages to correctly run pyreptasks.

To import all the classes and methods of the package in your Python projects: from pyreptasks import *

You may find examples of usage in the folder "examples".

Developing
==========

If you want to contribute, to ensure that you have all the needed dependencies installed in your local environment, install the requirements described in requirement_files/develop_requirements.txt. To do so, you can download the file or just copy it into a "develop_requirements.txt" file then do

% pip install -r develop_requirements.txt

This project uses "black" to format code. We support "pre-commit" to ensure this formatting has been run. If you have installed the requirements, you should have these packages already installed.

"Codecov" is set up for this project, so for any push or pull request you may check the code coverage report at https://app.codecov.io/gh/tsenovilla/pyreptasks. 

Testing
=======

This project uses "pytest" to run the tests defined in the folder "tests". 

To run the tests localy, install the test requirements described in requirement_files/tests_requirements.txt. To do so, you can download the file or just copy it into a "tests_requirements.txt" then do

% pip install -r test_requirements.txt

To run all the tests, go to the repository where you have stored the folder "tests" and run:

% pytest

In the case that you would like to run only a specific test, select it with pytest:

% pytest tests/test_switch.py

Versions log
============

Version 1.0.0
-------------

- New module switch.py: Contains the class Switch, allowing the user to skip defining a switch structure.

Version 2.0.0
-------------

- Update of module switch.py: From this version, integer_switch is not a parameter available for the class Switch   anymore. This parameter was used in a Switch object to indicate that the switch had to contain only integer keys. The parameter is deleted due to it was not actually useful. 

- Switch examples and tests updates to fit with the new version.

- Other changes: 
  - Adoption of the use of setuptools_scm (https://github.com/pypa/setuptools_scm/) package to manage version control instead of versioneer, used in the previous version. This also allows us to get rid of some configuration and version control files, in order to get a simpler package. 
  
  - Adoption of pyproject.toml in order to fit the standard PEP 518. 

  - Creation of release.yaml to automate releases when a new tag is pushed to GitHub. 

Version 2.0.1
-------------

- Bug fix: The version 2.0.0 changed the folder's name containing the source code, named "pyreptasks", to "src", without creating a "pyreptasks" package inside. This change created a conflict when importing the package, as its name was not anymore "pyreptasks" but "src". This new version solves that oblivion by creating a Python package "pyreptasks" inside the "src" folder. 

- Deletion of the file setup.py as it is not needed anymore with the introduction of pyproject.toml

- The former file "requirements.txt" might have been misunderstood, as it does not contain the actual requirements to run "pyreptasks", but the requirements to make correctly a git commitment. Due to up to this version there is not need of any other Python package to run "pyreptasks", this file is now named "develop_requirements.txt", and it is included in the new folder "requirement_files", with the file containing the packages needed for testing ("tests_requirements.txt"). If "pyreptasks" needs another Python package to run in the future, the "requirements.txt" file would be created again to carry out its actual rol. 

- As setup.py is not available anymore, the workflows have been updated accordingly.

Releasing
=========

Releases are published automatically when a tag is pushed to GitHub:

  export RELEASE=x.x.x

  git commit --allow-empty -m "Release $RELEASE"
  git tag -a $RELEASE -m "Version $RELEASE"

  git push upstream --tags

Workflows
=========

- CI (Continuous Integration): This workflow runs the test files contained in "tests" using pytest. It also runs code coverage to ensure the whole code is being used.

- Pre-commit: This workflow ensures that all Python files respect PEP 8 formatting, via black.

- Build distribution: This workflow ensures that each time a push is made, the project pushed is in a packageable state. Furthermore, if a tag is pushed, the workflow publishes the package on PyPI.


Other
=====

Author: Tomás Senovilla Polo

Email : tspscgs@gmail.com

License: pyreptasks is available under the MIT license. See LICENSE.txt for more information.

If you have in mind some functionality deserving to be included in "pyreptasks", let me know it! I will be happy to include it in a new version :smile:
