Metadata-Version: 2.1
Name: pybaserepo
Version: 0.0.17
Summary: A python package to enforce correctness of configuration values
Author-email: Ivan Lamperti <ivan.lamperti.work@gmail.com>
License: MIT License
        
        Copyright (c) 2022 The Python Packaging Authority (PyPA)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/odococo/pybaserepo
Project-URL: documentation, https://github.com/odococo/pybaserepo
Project-URL: repository, https://github.com/odococo/pybaserepo
Keywords: configuration
Classifier: Development Status :: 2 - Pre-Alpha
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Provides-Extra: dev
Requires-Dist: tox (~=4.2.0) ; extra == 'dev'
Requires-Dist: bumpver ; extra == 'dev'
Requires-Dist: pip-tools ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Provides-Extra: test
Requires-Dist: check-manifest ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'

# A sample Python project

A sample project to copy the correct structure of a python project.

## Pyproject.toml
Project properties to update:
* _name_ : name of the project
* _description_ : description of the project
* _authors_ : authors of the project
* _keywords_ : keywords to help search of the project
* _classifiers_ : one or more [classifiers](https://pypi.org/classifiers/) of the project
* _dependencies_ : equivalent to requirements.txt
* _urls_ : homepage, documentation and repository
* _scripts_ : startup script when executing like **python -m < project >**
* _tool.bumpver.file_pattern_ : name of the folder of the project

## Update to PyPi
Steps to update to pip:
* _tox -r_ : check integrity of the project and execute tests
* _bumpver update --patch_ : update version of the project. Also --minor and --major is supported
* _python -m build_ : build the project
* _twine check dist/*_ : check build files
* _twine upload dist/*_ : upload to PyPi (may upload before to testpypi with _twine upload -r testpypi dist/*_)
* _pip install < project >_ : to install the package and check it (may check before from testpypi with _pip install -i https://test.pypi.org/simple < project >_)

# Structure
Data folder is used for external files (like configuration files or scripts)

Basic packages to install: _pip install .[dev]_
