diff --git a/.gitignore b/.gitignore index b6e4761..efadd19 100644 --- a/.gitignore +++ b/.gitignore @@ -50,6 +50,8 @@ coverage.xml *.py,cover .hypothesis/ .pytest_cache/ +cover/ +.ruff_cache # Translations *.mo @@ -72,6 +74,7 @@ instance/ docs/_build/ # PyBuilder +.pybuilder/ target/ # Jupyter Notebook @@ -82,6 +85,8 @@ profile_default/ ipython_config.py # pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: .python-version # pipenv @@ -91,7 +96,24 @@ ipython_config.py # install all needed dependencies. #Pipfile.lock -# PEP 582; used by e.g. github.com/David-OConnor/pyflow +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm __pypackages__/ # Celery stuff @@ -127,3 +149,88 @@ dmypy.json # Pyre type checker .pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser diff --git a/.pep8 b/.pep8 deleted file mode 100644 index fcaeb4b..0000000 --- a/.pep8 +++ /dev/null @@ -1,11 +0,0 @@ -[pycodestyle] -max_line_length = 120 -ignore = E402, E722, E126, E731 -recursive = true -aggressive = 1 - -# config file used by autopep, which enhance pycodestyle -# see config options at : -# see https://pypi.org/project/autopep8/#features -# https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes -# interesting codes : E501, W6 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..3d7dfe1 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,40 @@ +# This file configures automated checks triggered by git events. +# To install pre-commit, run: `pip install pre-commit` +# +# To run all hooks manually, use: `pre-commit run -a` +# To enable automated checks on commit, run: `pre-commit install` +# +# See https://github.com/pre-commit/pre-commit for more information + +repos: + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.6.5 + hooks: + - id: ruff # linter + args: [ --fix ] + - id: ruff-format # formatter + + - repo: https://github.com/codespell-project/codespell + rev: v2.3.0 + hooks: + - id: codespell + additional_dependencies: + - tomli + + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-added-large-files + args: ["--maxkb=50"] + - id: check-docstring-first + - id: check-json + - id: check-yaml + - id: debug-statements + - id: requirements-txt-fixer + - id: check-case-conflict + - id: check-merge-conflict + - id: end-of-file-fixer + - id: mixed-line-ending + - id: requirements-txt-fixer + - id: trailing-whitespace + - id: check-symlinks diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index b1c3501..0000000 --- a/.pylintrc +++ /dev/null @@ -1,511 +0,0 @@ -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. -extension-pkg-whitelist= - -# Specify a score threshold to be exceeded before program exits with error. -fail-under=10.0 - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the -# number of processors available to use. -jobs=1 - -# Control the amount of potential inferred values when inferring a single -# object. This can help the performance when dealing with large functions or -# complex, nested conditions. -limit-inference-results=100 - -# List of plugins (as comma separated values of python module names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages. -suggestion-mode=yes - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once). You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use "--disable=all --enable=classes -# --disable=W". -disable=missing-function-docstring, - missing-class-docstring, - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable=c-extension-no-member - - -[REPORTS] - -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'error', 'warning', 'refactor', and 'convention' -# which contain the number of messages in each category, as well as 'statement' -# which is the total number of statements analyzed. This score is used by the -# global evaluation report (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details. -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=sys.exit - - -[LOGGING] - -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old - -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# Tells whether to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis). It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - -# List of decorators that change the signature of a decorated function. -signature-mutators= - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - -# Regular expression of note tags to take in consideration. -#notes-rgx= - - -[STRING] - -# This flag controls whether inconsistent-quotes generates a warning when the -# character used as a quote delimiter is used inconsistently within a module. -check-quote-consistency=no - -# This flag controls whether the implicit-str-concat should generate a warning -# on implicit string concatenation in sequences defined over several lines. -check-str-concat-over-line-jumps=no - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=120 - -# Maximum number of lines in a module. -max-module-lines=2450 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SPELLING] - -# Limits count of emitted suggestions for spelling mistakes. -max-spelling-suggestions=4 - -# Spelling dictionary name. Available dictionaries: none. To make it work, -# install the python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains the private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to the private dictionary (see the -# --spelling-private-dict-file option) instead of raising a message. -spelling-store-unknown-words=no - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_, - _cb - -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore. -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io - - -[BASIC] - -# Naming style matching correct argument names. -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# naming-style. -#argument-rgx= - -# Naming style matching correct attribute names. -attr-naming-style=snake_case - -# Regular expression matching correct attribute names. Overrides attr-naming- -# style. -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Bad variable names regexes, separated by a comma. If names match any regex, -# they will always be refused -bad-names-rgxs= - -# Naming style matching correct class attribute names. -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. -#class-attribute-rgx= - -# Naming style matching correct class names. -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-naming- -# style. -#class-rgx= - -# Naming style matching correct constant names. -const-naming-style=UPPER_CASE - -# Regular expression matching correct constant names. Overrides const-naming- -# style. -#const-rgx= - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming style matching correct function names. -function-naming-style=snake_case - -# Regular expression matching correct function names. Overrides function- -# naming-style. -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - ex, - Run, - _ - -# Good variable names regexes, separated by a comma. If names match any regex, -# they will always be accepted -good-names-rgxs= - -# Include a hint for the correct naming format with invalid-name. -include-naming-hint=no - -# Naming style matching correct inline iteration names. -inlinevar-naming-style=any - -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. -#inlinevar-rgx= - -# Naming style matching correct method names. -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-naming- -# style. -#method-rgx= - -# Naming style matching correct module names. -module-naming-style=snake_case - -# Regular expression matching correct module names. Overrides module-naming- -# style. -#module-rgx= - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -# These decorators are taken in consideration only for invalid-name. -property-classes=abc.abstractproperty - -# Naming style matching correct variable names. -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style. -#variable-rgx= - - -[DESIGN] - -# Maximum number of arguments for function / method. -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=5 - -# Maximum number of branch for function / method body. -max-branches=12 - -# Maximum number of locals for function / method body. -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body. -max-returns=6 - -# Maximum number of statements in function / method body. -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[IMPORTS] - -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled). -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled). -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled). -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - __post_init__ - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=cls - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "BaseException, Exception". -overgeneral-exceptions=BaseException, - Exception diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ca961a6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,57 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + +## [v2.0.0-rc.1] - 11/10/2024 + +### Added + +- `template_inputs.ini` file for configuring new package inputs +- `create_package.py` script to generate new Python packages from a template directory +- `pyproject.toml` file for project metadata, dependencies, and tool-specific settings +- New directory structure: + - `my_package/`: Main source code directory + - `scripts/`: Directory for utility scripts + - `tests/`: Directory for unit tests + - `CHANGELOG.md` File for tracking changes + - `README.md`: Main documentation file + - `setup.py`: Installation and package metadata + - `pyproject.toml`: Configuration file defining project metadata, dependencies, and tool-specific settings + - `test.py`: Script for running unittests and scripts with coverage + - `.gitlab/`: GitLab configuration files and templates + - `.gitlab-ci.yml`: File for GitLab CI/CD pipeline configuration + - `.gitignore`: File for Git ignore rules + - `.pre-commit-config.yaml`: File for pre-commit hooks configuration +- New tools for code quality checking and improving + +### Changed + +- Updated `README.md` with new project information and structure +- Reorganized project structure for better maintainability + +### Removed + +- Delete unused files that are no longer needed for the project: + - pep8, .pylintrc, ci_tests.py, coverage.py, python.gitignore, quickstart.py, setup_template.py, templates.py + + +## [v1.0.0] - 02/10/2023 + +### Changed + +- ‎Update README.md + +## [v0.1.0] - 07/01/2021 + +### Added + +- Add quickstart.py + + +## [v0.0.1] - 22/10/2020 (Initialization) + + diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index 7b6810b..275c9c7 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,193 @@ -# dessia_bot_template -A template to build a dessia-compatible bot. +## dessia_bot_template -## Usage +This repository provides a template for creating new Python packages. It includes all the necessary boilerplate code and directory structure to help you get started quickly and maintain consistency across your projects. + + +## Table of Contents + + - [Overview](#overview) + - [Features](#features) + - [Getting Started](#getting-started) + - [Usage](#usage) + - [Directory Structure](#directory-structure) + - [Troubleshooting](#troubleshooting) + - [Contact](#contact) + + +## Overview + +**dessia_bot_template** is a streamlined tool designed to help developers quickly generate new Python packages by providing a pre-configured project structure. By simply filling out a configuration .ini file with essential package metadata, users can create a new package with all the necessary structure, including essential files like setup.py, README.md, and tests, initialize a Git repository, and push it to a remote Git repository. + +This template simplifies the process of starting a new Python project, allowing you to focus more on coding and less on setup. + + +## Features + + - **Standardized Directory Structure for Python Packages:** +Automatically creates a well-organized directory structure, including directories for your package's modules, tests, and additional resources. This ensures your project is easy to navigate and adheres to Python best practices. + + - **Pre-configured setup.py and pyproject.toml for Easy Package Installation and Distribution:** + Provides a ready-to-use setup.py and pyproject.toml files tailored to your package's metadata. These files simplifie the installation process and make your package easily distributable via PyPI or other distribution platforms. + + - **Example Test Cases Using pytest:** + Includes a set of example test cases to get you started with testing your package using pytest. This helps ensure your package is robust and reliable, encouraging best practices in test-driven development. + + - **Automated Git Initialization and Remote Repository Setup:** + Automatically initializes a Git repository for your package, commits the initial setup, and pushes it to a remote repository specified by you. This feature helps you manage your code from the very beginning with version control. + + - **Customizable Package Metadata:** + Easily customize your package's name, version, author information, descriptions, and more through a configuration .ini inputs file. This flexibility allows you to tailor the package to your specific project requirements. + + - **Python Version and Dependency Management:** + Specify the required Python version and manage package dependencies directly from the configuration .ini inputs file. This ensures your package is compatible with the intended Python environment and has all necessary dependencies. + + - **Cross-Platform Compatibility:** + Designed to work seamlessly on Windows, macOS, and Linux, making it accessible to developers across different platforms. + + - **Error Handling and Validation:** + Built-in checks validate your inputs data, such as checking for valid package names, correctly formatted email addresses, and non-conflicting dependencies. This reduces the likelihood of common errors and saves you time. + + - **Expandable and Customizable:** + The template can be easily modified to include additional files, directories, or configurations. You can extend the template to suit more complex project requirements or specific use cases. + + - **Built-in Documentation Support:** + Automatically generates a basic README.md file based on your inputs, providing a starting point for your project documentation. This ensures your package is well-documented from the outset. + + - **Continuous integration (CI) configuration examples:** + The template is pre-configured for easy integration with CI/CD Gitlab tools. This feature allows you to automate testing, deployment, and other processes, streamlining your development workflow. + + +## Getting Started + +1. **Prerequisites** + +Before using this template, ensure you have the following installed: -### 1. Clone the Repository +- Python: Version 3.9 or later. +- Git: Version control system to manage your codebase - Optional. -First, clone this repository to your local machine using the following command: +2. **Installation** + + +Clone this template repository to your local machine: ``` git clone https://github.com/Dessia-tech/dessia_bot_template.git cd dessia_bot_template +``` -2. Execute the Quickstart Script -Run the quickstart Python script to set up your bot project. Depending on your operating system, you might need to use python or python3. Choose the appropriate command for your system: -On Linux/macOS: -python3 quickstart.py +This template includes some Python dependencies for the script, install them: -On Windows: -python quickstart.py +``` +pip install -r requirements.txt +``` -The quickstart script will ask you a series of questions to configure your bot project. +## Usage -3. Answer the Questions: +1. **Fill in the .ini Inputs File** -The quickstart script will prompt you with questions to customize your bot project. Here's what each question is about: +Open the file template_inputs.ini, and fill in the following fields: -Package Name: Enter a name for your bot's package. This should be a lowercase name without special characters except for underscores. + - **package_name**: This is the unique name of your Python package. It should be all lowercase and use underscores to separate words (e.g., my_package). + - **short_description**: A concise summary of what your package does. This will appear in package listings and should be clear and to the point. Aim for one sentence. + - **long_description**: A more detailed description of your package. This can be a few paragraphs long and should explain the package’s features, use cases, and any important details. This will typically be included in the README.md file which can be updated after. + - **required_packages**: A list of other Python packages that your package depends on. These dependencies will be automatically installed when your package is installed. List each package separated by a comma. + - **python_version**: The minimum version of Python that your package is compatible with. Specify the version in the format >= followed by the version number. + - **author**: The name of the person or team responsible for maintaining the package. This should be the operations-team that will handle updates, support, and maintenance of the package. + - **email**: The contact email of the person or team responsible of the package. This email should be monitored for any support requests, questions, or issues related to the package. + - **package_url**: This URL where the package's source code will be created. Typically, this will be the URL of the repository hosting the package (e.g., a GitLab, GitHub repository) - Optional. Like: gitlab.com/Organisation -Git Integration: Decide if you want to use Git for version control. If you choose "yes," make sure you have a Git repository set up and cloned to your computer. -Parent Folder: Specify the parent folder where your bot project will be generated. You can choose an existing folder or create a new one. +**Example:** -Module Name: Choose a name for the main module of your bot. The default is "core." +``` +| Item | Example | +├──────────────────├────────────────────────────────────────────────────────────| +| package_name | my_package | +| short_description| A package that does awesome things | +| long_description | This package provides awesome features for awesome people. | +| required_packages| dessia_common>=0.18.0, plot_data>=0.26.0 | +| python_version | >=3.9 | +| author | Operations-Team | +| email | support@dessia.io | +| package_url | gitlab.com/Organisation/ClientFolder | +``` + +2. **Run the Script** + +After filling in the .ini inputs file, run the create_package.py script to generate your new package. However, if you want to push your new package to GitHub instead of GitLab, you will need to create an empty repository on GitHub before running the script. -Short Description: Provide a short description of your bot. + - Log in to your GitHub account + - Click the "+" icon in the top-right corner and select "New repository" + - Choose a project name for your repository (the directory containing your package): The project name is the CamelCase version of the package name choosen in the .ini inputs file + - Do not initialize the repository with a README, .gitignore, or license + - Click "Create repository" -Author Name: Enter your name. +Then, -Author Email: Enter your mail address. + - Run the create_package.py script + +``` +python3 create_package.py +``` -Required Packages: List any required Python packages separated by commas. You can use the default requirements or specify your own. +The script will: + + - Create a new directory for your package. + - Populate it with the necessary files (e.g., setup.py, README.md, gitlab-ci.yml, etc.). + - Initialize a local Git repository. + - Add and commit all the files. + - Push the initial commit to the remote repository specified in the inputs file. + +3. **Push to Git** + +If the script hasn't automatically pushed to the remote repository, you can manually push your changes: + +``` +git push -u origin master +``` + + +## Directory Structure + +Here's an overview of the directory structure provided by this template: + +``` +MyPackage/ +├── my_package/ # Main source code directory +│ ├── __init__.py # Initialize your package +│ ├── module_1.py # Example module 1 +│ └── module_2.py # Example module 2 +├── scripts/ # Directory for utility scripts related to the package +│ ├── script_1.py # Utility script 1 +│ ├── script_2.py # Utility script 2 +├── tests/ # Directory for unit tests +│ ├── __init__.py # Initialize test package +│ └── test_example.py # Example test file +├── CHANGELOG.md # Changelog for tracking changes +├── README.md # Main documentation file +├── setup.py # Installation and package metadata +├── pyproject.toml # Configuration file defining project metadata, dependencies, and tool-specific settings +├── test.py # Test script for running unittests and scripts with coverage +├── .gitlab/ # GitLab configuration files and templates +│ ├── issue_template.md # Template for submitting issues +│ └── merge_request_template.md # Template for merge requests +├── .gitlab-ci.yml # GitLab CI/CD pipeline configuration +├── .gitignore # Git ignore rules +└── .pre-commit-config.yaml # Pre-commit hooks configuration +``` -Python Version: Specify the minimum Python version your bot requires. The default is ">=3.8." -Version from Git Tags: Decide whether you want to enable versioning based on Git tags (example v0.0.1). +## Troubleshooting -Gitignore File: Choose whether to create a Python-specific .gitignore file. + - Git Push Failures: + Ensure you have push access to the remote repository. If you encounter authentication issues, check your Git credentials and SSH keys. -Readme File: Choose whether to create a README file. This file will be used as the description of your project. + - Package Name Conflicts: + Be sure that the chosen package name does not already exist in your organization or on PyPI. So, consider choosing a different name to avoid conflicts. -Tests: Decide whether to include code coverage and CI tests. -Code Quality Checks: Choose whether to include code quality checks like PEP8 and pylint. +## Contact -CI (Continuous integraton): Decide whether to generate a .drone.yml file for drone.io CI. \ No newline at end of file +For any questions or issues, please contact the Operations-Team. diff --git a/ci_tests.py b/ci_tests.py deleted file mode 100644 index bc5feef..0000000 --- a/ci_tests.py +++ /dev/null @@ -1,11 +0,0 @@ - -import os - -# for some akward reason, put scripts before unittests tests -scripts = [ - 'import.py', - ] - -for script_name in scripts: - print('\n## Executing script {}'.format(script_name)) - exec(open(script_name).read()) diff --git a/coverage.py b/coverage.py deleted file mode 100644 index 6060cf9..0000000 --- a/coverage.py +++ /dev/null @@ -1,43 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -""" - -""" - -import json - -MIN_FILE_COVERAGE = 50. -MIN_MODULE_COVERAGE = 50. - -untracked_modules = [ -] - -print("untracked modules:", untracked_modules) - -with open("coverage.json", "r") as file: - d = json.load(file) - -print('total covered', d['totals']['percent_covered'], '%') -if d['totals']['percent_covered'] < MIN_MODULE_COVERAGE: - raise RuntimeError('Package is not covered enough by tests: {}% expected minimum {}%'.format( - d['totals']['percent_covered'], MIN_MODULE_COVERAGE)) - -print('[Coverage] You can increase MIN_MODULE_COVERAGE to maximum {}% (actual {}%)'.format( - d['totals']['percent_covered'], MIN_MODULE_COVERAGE)) - -min_actual_coverage = 100 -for file_name, data in d['files'].items(): - print(file_name, data['summary']['percent_covered'], '%') - # print('/'.join(file_name.split('/')[-2:])) - if '/'.join(file_name.split('/')[-2:]) in untracked_modules: - print(file_name, '-> in untrack list') - else: - # print('Testing if {} is above {}'.format(file_name, MIN_FILE_COVERAGE)) - if data['summary']['percent_covered'] < MIN_FILE_COVERAGE: - raise RuntimeError('Module {} is not covered enough by tests: {}% expected minimum {}%'.format( - file_name, data['summary']['percent_covered'], MIN_FILE_COVERAGE)) - min_actual_coverage = min( - min_actual_coverage, data['summary']['percent_covered']) - -print('[Coverage] You can increase MIN_FILE_COVERAGE to maximum {}% (actual:{})%'.format( - min_actual_coverage, MIN_FILE_COVERAGE)) diff --git a/create_package.py b/create_package.py new file mode 100644 index 0000000..38f36a5 --- /dev/null +++ b/create_package.py @@ -0,0 +1,87 @@ +"""Script to generate a new Python package from a template directory.""" + +import os +import shutil +import subprocess +from datetime import date + +from methods.methods_get_parameters_from_ini_file import get_parameters_from_ini_file + +# %% Inputs + +parameters = get_parameters_from_ini_file(ini_file="template_inputs.ini") + +# %% New Directory + +# Path to the template directory +template_dir = "package_folder" +new_package_dir = f'../{parameters["project_package_name"]}' + +# Copy the template directory to a new location +shutil.copytree(template_dir, new_package_dir) + +# Rename the package folder +old_folder = f'../{parameters["project_package_name"]}/folder' +new_folder = f'../{parameters["project_package_name"]}/' + parameters["package_name"] +os.rename(old_folder, new_folder) + +# %% Updates the files + + +# Function to replace placeholders in a file +def replace_placeholders(_file_path: str, _placeholders: dict) -> None: + """Replace placeholders in a file with the corresponding values.""" + with open(_file_path, encoding="utf-8") as file: + content = file.read() + for placeholder, value in _placeholders.items(): + content = content.replace(placeholder, value) + with open(_file_path, "w", encoding="utf-8") as file: + file.write(content) + + +# Dictionary of placeholders to replace +placeholders = { + "{{PACKAGE_NAME}}": parameters["package_name"], + "{{PROJECT_NAME}}": parameters["project_package_name"], + "{{LONG_DESCRIPTION}}": parameters["long_description"], + "{{SHORT_DESCRIPTION}}": parameters["short_description"], + "{{AUTHOR}}": parameters["author"], + "{{CONTACT}}": parameters["email"], + "{{VERSION}}": parameters["python_version"], + "{{DATE}}": date.today().strftime("%d/%m/%Y") + " (Initialization)", + "{{REQUIRED_PACKAGES}}": parameters["required_packages"], +} + + +# Recursively find and update all files in the new package directory +for root, _dirs, files in os.walk(new_package_dir): + for file_name in files: + file_path = os.path.join(root, file_name) + replace_placeholders(file_path, placeholders) + +print(f"\nThe package '{parameters['package_name']}' has been successfully generated in {new_package_dir}.\n") + +# %% Git Repository + +# Initialize a new Git repository +os.chdir(new_package_dir) # Change directory to the new package directory +subprocess.run(["git", "init"], check=False) # Initialize a new git repository +subprocess.run(["git", "add", "."], check=False) # Add all files to staging +subprocess.run(["git", "commit", "-m", "Initial commit"], check=False) # Commit the changes + +# Rename the default branch to 'master' +subprocess.run(["git", "branch", "-M", "master"], check=False) + +if parameters["package_url"]: + # Set up the upstream repository and push + push_command = ( + f"git push --set-upstream git@{parameters['package_url']}/" + f"$(git rev-parse --show-toplevel | xargs basename).git " + f"$(git rev-parse --abbrev-ref HEAD)" + ) + subprocess.run(push_command, shell=True, check=False) + + print(f"\nA new Git repository has been initialized in {new_package_dir}.") + +else: + print(f"\nA new local Git repository has been initialized in {new_package_dir}.") diff --git a/logo.png b/logo.png deleted file mode 100644 index 70050e8..0000000 Binary files a/logo.png and /dev/null differ diff --git a/methods/methods_check_inputs.py b/methods/methods_check_inputs.py new file mode 100644 index 0000000..e8a15c1 --- /dev/null +++ b/methods/methods_check_inputs.py @@ -0,0 +1,70 @@ +"""This module contains functions to check the validity of the inputs provided by the user.""" + +import re +from http import HTTPStatus + +import requests + + +def validate_package_name(name: str) -> None: + """Check if the package name follows Python naming conventions.""" + if not name: + raise ValueError("\nYou need to add a 'Package name'") + + if not re.match(r"^[a-z_][a-z0-9_]*$", name): + raise ValueError( + f"Invalid package name '{name}'. Package names must start with a letter or underscore and contain only lowercase letters, numbers, and underscores. Single and double quotes and double are not authorized." + ) + + +def check_pypi_package_name(name: str) -> None: + """Check if the package name already exists on PyPI.""" + response = requests.get(f"https://pypi.org/pypi/{name}/json") + + if response.status_code == HTTPStatus.OK: + print(f"Warning: The package name '{name}' already exists on PyPI. Consider choosing a different name.") + + +def validate_email(email: str) -> None: + """Validate the email format.""" + if not re.match(r"[^@]+@[^@]+\.[^@]+", email): + raise ValueError(f"Invalid email address '{email}'.") + + +def validate_url(url: str) -> None: + """Validate the URL format.""" + # if not url: + # raise ValueError("\nYou need to add a 'Package URL'") + + # if not re.match(r'^gitlab\.com:', url): + # raise ValueError(f"\nAre you sure about your 'Package URL' = {url} ? " +\ + # "The package must be sorted in Dessia Organization (as: gitlab.com/dessia/XX)") + + if not ("gitlab" in url.lower() or "github" in url.lower()): + raise ValueError( + f"\nAre you sure about your 'Package URL' = {url} ? It is not a Git URL\n" + + "If you do not need to use Git, leave an empty cell." + ) + + +def transform_url(url: str) -> str: + """Transform the given URL to be used for Gitlab pusing.""" + # Remove 'www.' if present + url = url.replace("www.", "", 1) + + # Replace the first '/' with ':' + return url.replace("/", ":", 1) + + +def validate_python_version(version: str) -> None: + """Validate the Python version format.""" + if not re.match(r"^>=?(\d+\.\d+)$", version): + raise ValueError(f"Invalid Python version '{version}'. Example of a valid version: >=3.8.") + + +def validate_required_packages(packages: str) -> None: + """Validate the format of required packages and versions.""" + if packages: + for package in packages.split(","): + if not re.match(r"^[a-zA-Z0-9_-]+(==|>=|<=|~=)?[0-9.]*$", package.strip()): + raise ValueError(f"Invalid package requirement '{package}'. Ensure correct formatting.") diff --git a/methods/methods_get_parameters_from_ini_file.py b/methods/methods_get_parameters_from_ini_file.py new file mode 100644 index 0000000..770eeb5 --- /dev/null +++ b/methods/methods_get_parameters_from_ini_file.py @@ -0,0 +1,92 @@ +"""Functions to get parameters from an ini file.""" + +import configparser + +from .methods_check_inputs import ( + check_pypi_package_name, + transform_url, + validate_email, + validate_package_name, + validate_python_version, + validate_required_packages, + validate_url, +) + + +def read_config_to_dict(file_path: str) -> dict: + """"Read a configuration file and returns its contents as a dictionary, excluding the 'DOCUMENTATION' section.""" + config = configparser.ConfigParser() + config.read(file_path) + + config_dict = {} + + for section in config.sections(): + if section != "DOCUMENTATION": + for key, value in config[section].items(): + config_dict[key] = value.strip() + + return config_dict + + +def get_parameters_from_ini_file(ini_file: str) -> dict: + """Get the parameters from an ini file.""" + parameters = read_config_to_dict(ini_file) + + # %% Package name + + package_name = parameters["package_name"] + validate_package_name(package_name) + check_pypi_package_name(package_name) + + project_package_name = "".join(x.title() for x in package_name.split("_")) + parameters["project_package_name"] = project_package_name + + # %% Package URL + + package_url = parameters["package_url"] + if package_url: + validate_url(package_url) + parameters["package_url"] = transform_url(package_url) + + # %% Short description + + if not parameters["short_description"]: + parameters["short_description"] = "A Specific python package for a technological issue." + + # %% Long description + + if not parameters["long_description"]: + parameters["long_description"] = ( + "A Python package using DessiA SDK tools and coding guidelines (https://documentation.dessia.io)" + ) + + # %% Python version + + version = parameters["python_version"] + if not version: + parameters["python_version"] = ">=3.9" + else: + validate_python_version(version) + + # %% Author + + if not parameters["author"]: + parameters["author"] = "Operations-Team" + + # %% E-mail + + contact = parameters["email"] + if not contact: + parameters["email"] = "support@dessia.io" + else: + validate_email(contact) + + # %% Required packages + + required_packages = parameters["required_packages"] + if not required_packages: + required_packages = ["dessia_common>=0.18.0, plot_data>=0.26.0"] + else: + validate_required_packages(required_packages) + + return parameters diff --git a/package_folder/.gitignore b/package_folder/.gitignore new file mode 100644 index 0000000..efadd19 --- /dev/null +++ b/package_folder/.gitignore @@ -0,0 +1,236 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ +.ruff_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser diff --git a/package_folder/.gitlab-ci.yml b/package_folder/.gitlab-ci.yml new file mode 100644 index 0000000..3071479 --- /dev/null +++ b/package_folder/.gitlab-ci.yml @@ -0,0 +1,76 @@ +# Gitlab CI configuration file for the package. +# You can use your own specific runner tags and images by changing the values in the tags and image fields + +stages: + - verify + - check + - test + + +# Verify that the changelog has been updated +verify_changelog_update: + stage: verify + tags: + - dessia_ubuntu + image: python:3.9 + script: + - git remote set-url origin $CI_REPOSITORY_URL + - if [ "$(git rev-parse --is-shallow-repository)" = "true" ]; then + git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME --unshallow; + else + git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME; + fi + - git fetch origin $CI_COMMIT_REF_NAME + - if git diff --name-only origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...origin/$CI_COMMIT_REF_NAME | grep -q 'CHANGELOG.md'; then echo "Changelog has been updated"; else echo "CHANGELOG.md has not been updated. Update it for the PR to be accepted in CI."; exit 1; fi + rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + + +# Check pre-commit hooks +check_pre_commit: + stage: check + tags: + - dessia_ubuntu + image: python:3.9 + script: + - pip install pre-commit shellcheck-py + - pre-commit run -a + rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + + +# Test the package with unittests and run scripts, and generate coverage report +install_run_scripts_and_unittests: + stage: test + tags: + - dessia_ubuntu + image: python:3.9 + script: + - git fetch --tags + - apt-get update && apt-get install -y libgl1 + - python3 -m pip install --upgrade pip + - pip install git+https://github.com/Dessia-tech/dessia_common.git + - pip install git+https://gitlab-ci-token:$CI_JOB_TOKEN@gitlab.com/dessia/sdk/volmdlr.git + - pip install -e .[doc,test] + - pip install coverage tomli + - python3 test.py + rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + + +# Generate dist wheel and source distribution on master branch +generate_dist_wheel: + stage: test + tags: + - dessia_ubuntu + image: python:3.9 + script: + - pip install setuptools wheel + - python setup.py sdist bdist_wheel + rules: + - if: '$CI_COMMIT_BRANCH == "master"' + - if: '$CI_COMMIT_BRANCH == "testing"' + artifacts: + paths: + - dist/*.whl + - dist/*.tar.gz diff --git a/package_folder/.gitlab/issue_templates/issue_template.md b/package_folder/.gitlab/issue_templates/issue_template.md new file mode 100644 index 0000000..f1a38d6 --- /dev/null +++ b/package_folder/.gitlab/issue_templates/issue_template.md @@ -0,0 +1,45 @@ +### Issue Type + - [ ] bug report + - [ ] feature request + + +### Description +- Provide a detailed description of the issue or feature request. Include as much relevant information as possible. + + +### Steps to Reproduce (for bugs) +1. Describe the steps necessary to reproduce the issue. +2. Include any relevant commands or code snippets. + + +### Expected Behavior +- Describe what you expected to happen. + + +### Actual Behavior +- Describe what actually happened. Include screenshots or logs if they help illustrate the issue + + +### Environment +- Include information about your environment that might be relevant: + - **Python Version**: + + - **Package Version**: + + - **Volmdlr Version**: + + - **Dessia_common Version**: + + - **Plot_data Version**: + + +### Additional Information +- Provide any additional information that might help diagnose the problem, such as recent changes to your system or configuration. + + +### Possible Solution (optional) +- If you have an idea of what might be causing the issue or how to fix it, please provide details here. + + +### Related Issues +- If this issue is related to or duplicates another issue, please provide links to those issues. diff --git a/package_folder/.gitlab/merge_request_templates/merge_request_template.md b/package_folder/.gitlab/merge_request_templates/merge_request_template.md new file mode 100644 index 0000000..4a2e3c4 --- /dev/null +++ b/package_folder/.gitlab/merge_request_templates/merge_request_template.md @@ -0,0 +1,37 @@ +### Description +- Provide a detailed description of the changes proposed in this merge request. Explain why these changes are being made and what problem they solve. + + +### Related Issues +- Link any related issues or tickets that this merge request addresses. For example: `Fixes #123`, `Related to #456`. + + +### Type of Change +- Select the type of change this merge request introduces: + - [ ] **Bug fix**: Fixes an issue or bug. + - [ ] **New feature**: Adds a new feature or functionality. + - [ ] **Enhancement**: Improves existing functionality. + - [ ] **Refactoring**: Changes code structure without affecting functionality. + - [ ] **Documentation**: Updates or adds documentation. + - [ ] **Other**: Describe any other type of change. + + +### Checklist +- Ensure that your merge request meets the following criteria: + - The request is thematic and its title is explicit. + - The commit messages follow our guidelines (explicit, in english) + - Code follows the project's coding style guidelines. + - Code is well-tested with unit tests and/or integration tests. + - Documentation has been updated. + - Any new dependencies have been added to `requirements.txt` (if applicable). + - CHANGELOG.md has been updated + - Merge request includes relevant screenshots (if applicable). + + +### Testing +- Describe how you tested the changes. Include details about the environment and any specific tests you performed. +- Include any relevant test results or logs. + + +### Additional Information +- Provide any additional information that may be useful for reviewers, such as potential impacts on other parts of the project, specific areas to review, or known issues. diff --git a/package_folder/.pre-commit-config.yaml b/package_folder/.pre-commit-config.yaml new file mode 100644 index 0000000..8f8c1c0 --- /dev/null +++ b/package_folder/.pre-commit-config.yaml @@ -0,0 +1,48 @@ +# This file configures automated checks triggered by git events. +# To install pre-commit, run: `pip install pre-commit` +# +# To run all hooks manually, use: `pre-commit run -a` +# To enable automated checks on commit, run: `pre-commit install` +# +# See https://github.com/pre-commit/pre-commit for more information + +repos: + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.6.5 + hooks: + - id: ruff # linter + args: [ --fix ] + - id: ruff-format # formatter + + - repo: https://github.com/codespell-project/codespell + rev: v2.3.0 + hooks: + - id: codespell + additional_dependencies: + - tomli + + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-added-large-files + args: ["--maxkb=50"] + - id: check-docstring-first + - id: check-json + - id: check-yaml + - id: debug-statements + - id: requirements-txt-fixer + - id: check-case-conflict + - id: check-merge-conflict + - id: end-of-file-fixer + - id: mixed-line-ending + - id: requirements-txt-fixer + - id: trailing-whitespace + - id: check-symlinks + + - repo: local + hooks: + - id: shellcheck + name: shellcheck + entry: shellcheck + language: system + types: [shell] diff --git a/package_folder/CHANGELOG.md b/package_folder/CHANGELOG.md new file mode 100644 index 0000000..3071e24 --- /dev/null +++ b/package_folder/CHANGELOG.md @@ -0,0 +1,44 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + +## [v0.1.0] - Unreleased + +### Added + +- For new features or enhancements introduced in the release. + +### Changed + +- For modifications to existing functionality. + +### Deprecated + +- To indicate features that are being phased out and may be removed in future releases. + +### Removed + +- For features or files that have been eliminated from the project. + +### Fixed + +- To document bug fixes and corrections made in the release. + +### Security + +- For updates that address security vulnerabilities. + +### Performance + +- To highlight improvements in performance metrics or efficiency. + +### Other + +- For miscellaneous changes that don’t fit into the above categories, such as documentation updates or minor tweaks. + + +## [v0.0.1] - {{DATE}} diff --git a/package_folder/README.md b/package_folder/README.md new file mode 100644 index 0000000..1be4b16 --- /dev/null +++ b/package_folder/README.md @@ -0,0 +1,30 @@ +# {{PROJECT_NAME}} + +{{LONG_DESCRIPTION}} + +## Installation + +The package can be installed using pip, from the root directory of the package: + +```bash +pip install -e . +``` +> Note: The `-e` flag is optional and used to install the package in editable mode. +> This allows to modify the package and see the changes without reinstalling it. + +## Usage + +See the scripts folder for examples. + +## Features + + +## Contributing + + +## License + + +## Contact + +For any questions or issues, please contact the {{AUTHOR}} at {{CONTACT}}. diff --git a/package_folder/folder/__init__.py b/package_folder/folder/__init__.py new file mode 100644 index 0000000..e762c58 --- /dev/null +++ b/package_folder/folder/__init__.py @@ -0,0 +1 @@ +"""{{PROJECT_NAME}} Package.""" diff --git a/package_folder/folder/module_1.py b/package_folder/folder/module_1.py new file mode 100644 index 0000000..13df3b7 --- /dev/null +++ b/package_folder/folder/module_1.py @@ -0,0 +1 @@ +"""Module Documentation.""" diff --git a/package_folder/folder/module_2.py b/package_folder/folder/module_2.py new file mode 100644 index 0000000..13df3b7 --- /dev/null +++ b/package_folder/folder/module_2.py @@ -0,0 +1 @@ +"""Module Documentation.""" diff --git a/package_folder/pyproject.toml b/package_folder/pyproject.toml new file mode 100644 index 0000000..aa6a540 --- /dev/null +++ b/package_folder/pyproject.toml @@ -0,0 +1,46 @@ +[build-system] +requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=6.0"] +build-backend = "setuptools.build_meta" + +[tool.ruff] +line-length = 120 +target-version = "py39" + +[tool.ruff.lint] +preview = true +select = [ # https://docs.astral.sh/ruff/rules + "E4", "E7", "E9", # pycodestyle coding rules + "F", # Pyflakes + "B", # flake8-bugbear + "I", # isort + "N", # pep8-naming + "D", # pydocstyle documentation + "UP", # pyupgrade + "ANN001", # missing type annotation for function arguments + "ANN201", # missing type annotation for function return value + "PL", # pylint + "NPY", # NumPy-specific rules + "PERF", # Perflint + "RUF", # Ruff-specific rules +] + +[tool.ruff.lint.pydocstyle] +convention = "pep257" + +[tool.ruff.lint.per-file-ignores] +"tests/**/*.py" = ["D"] # documenting the unit tests is not necessary + +[tool.codespell] +skip = ["*.json", "*.html", "*.js", "*.css", ".c", ".h", ".cpp", ".hpp", "*.xml"] +ignore-words-list = ["dessia"] # words to ignore from codespell check + +[tool.coverage.run] +source = ["{{PACKAGE_NAME}}"] # source code directories + +[tool.coverage.report] +omit = [] # modules to omit from coverage analysis + +[coverage] +min_global_coverage = 90 # minimum global coverage percentage +min_module_coverage = 80 # minimum coverage percentage for each module +untracked_scripts = [] # not tested scripts (relative path to scripts directory) diff --git a/package_folder/scripts/script_1.py b/package_folder/scripts/script_1.py new file mode 100644 index 0000000..a6d540d --- /dev/null +++ b/package_folder/scripts/script_1.py @@ -0,0 +1 @@ +"""Script_1.""" diff --git a/package_folder/scripts/script_2.py b/package_folder/scripts/script_2.py new file mode 100644 index 0000000..13d29c9 --- /dev/null +++ b/package_folder/scripts/script_2.py @@ -0,0 +1 @@ +"""Script_2.""" diff --git a/package_folder/setup.py b/package_folder/setup.py new file mode 100644 index 0000000..7290627 --- /dev/null +++ b/package_folder/setup.py @@ -0,0 +1,26 @@ +"""Setup file.""" + +from setuptools import find_packages, setup + + +def readme() -> str: + """Read the README file.""" + with open("README.md", encoding="utf-8") as f: + return f.read() + + +install_requires = ["{{REQUIRED_PACKAGES}}"][0].split(",") + +setup( + name="{{PACKAGE_NAME}}", + use_scm_version=True, + setup_requires=["setuptools_scm"], + description="{{SHORT_DESCRIPTION}}", + long_description=readme(), + long_description_content_type="text/markdown", + author="{{AUTHOR}}", + author_email="{{CONTACT}}", + install_requires=install_requires, + python_requires="{{VERSION}}", + packages=find_packages(), +) diff --git a/package_folder/test.py b/package_folder/test.py new file mode 100644 index 0000000..4f254ba --- /dev/null +++ b/package_folder/test.py @@ -0,0 +1,134 @@ +"""Test script for running unittests and scripts with coverage.""" + +import json +import os +import subprocess +import sys +import time +from pathlib import Path +from typing import Any, Optional + +import tomli + + +def setup_environment() -> None: + """Set up environment variables for coverage.""" + os.environ["COVERAGE_FILE"] = str(Path(__file__).parent.resolve() / ".coverage") + os.environ["COVERAGE_RCFILE"] = str(Path(__file__).parent.resolve() / "pyproject.toml") + + +def load_config() -> dict[str, Any]: + """Load configuration file.""" + with open(str(Path(__file__).parent.resolve() / "pyproject.toml"), "rb") as file: + config = tomli.load(file) + + # Extract the [coverage] section + coverage_config = config.get("coverage", {}) + return coverage_config + + +def run_unittests_coverage() -> int: + """Run coverage on unittests.""" + result = subprocess.run( + ["coverage", "run", "-m", "unittest", "discover", "-v"], + check=False, + ) + return result.returncode + + +def run_scripts_coverage(untracked_scripts: Optional[list[str]] = None) -> int: + """Run all scripts with coverage.""" + returncode = 0 + scripts_dir = Path("scripts") + print(f" Untracked scripts: {untracked_scripts}") + + for script in scripts_dir.rglob("*.py"): + script_path = script.relative_to(scripts_dir) + + if str(script_path) not in untracked_scripts: + print(f"\n * Running {script_path}") + start = time.perf_counter() + result = subprocess.run( + ["coverage", "run", "-a", script.name], + cwd=script.parent, + check=False, + text=True, + ) + if result.returncode != 0: + print(f"ERROR: Script {script_path} failed") + returncode = 1 + else: + print(f" OK: {script_path} ran in {time.perf_counter() - start:.2f}s") + + return returncode + + +def check_coverage_thresholds(config: dict[str, Any]) -> int: + """Check coverage thresholds using the JSON report.""" + returncode = 0 + + # Generate JSON coverage report + subprocess.run(["coverage", "json"], check=True) + + # Load JSON coverage report + with open("coverage.json", encoding="utf-8") as file: + coverage_report = json.load(file) + + # Check global coverage threshold + global_coverage = coverage_report["totals"]["percent_covered"] + threshold = config.get("min_global_coverage", 0) + if global_coverage < threshold: + print( + f"ERROR: Global coverage is below the threshold of {threshold}%. Current coverage: {global_coverage:.2f}%" + ) + returncode = 1 + + # Check per-module coverage thresholds + threshold = config.get("min_module_coverage", 0) + for module_name, data in coverage_report["files"].items(): + module_coverage = data["summary"]["percent_covered"] + + if module_coverage < threshold: + print( + f""" +ERROR: Module {module_name} coverage is below the threshold of {threshold}%. Current coverage: {module_coverage:.2f}% +""" + ) + returncode = 1 + + return returncode + + +def main() -> None: + """Run all tests and check coverage.""" + setup_environment() + config = load_config() + + print("\n> RUNNING UNITTESTS") + unittests_returncode = run_unittests_coverage() + + print("\n> RUNNING SCRIPTS") + scripts_returncode = run_scripts_coverage(untracked_scripts=config.get("untracked_scripts", [])) + + print("\n> CHECKING COVERAGE") + time.sleep(1) + subprocess.run(["coverage", "report", "-m"], check=False) + subprocess.run(["coverage", "html", "-d", "htmlcov", "-q"], check=False) + + coverage_returncode = check_coverage_thresholds(config) + + print() + if unittests_returncode + scripts_returncode + coverage_returncode == 0: + print("SUCCESS: All tests passed.") + if unittests_returncode != 0: + print("ERROR: Some unittests failed.") + if scripts_returncode != 0: + print("ERROR: Some scripts failed.") + if coverage_returncode != 0: + print("ERROR: Coverage is below the threshold.") + + sys.exit(unittests_returncode + scripts_returncode + coverage_returncode) + + +if __name__ == "__main__": + main() diff --git a/package_folder/tests/__init__.py b/package_folder/tests/__init__.py new file mode 100644 index 0000000..afa08e6 --- /dev/null +++ b/package_folder/tests/__init__.py @@ -0,0 +1 @@ +"""Unit testing package.""" diff --git a/package_folder/tests/test_exemple.py b/package_folder/tests/test_exemple.py new file mode 100644 index 0000000..67bf23c --- /dev/null +++ b/package_folder/tests/test_exemple.py @@ -0,0 +1,13 @@ +import unittest + +import numpy as np + + +class TestClassName(unittest.TestCase): + def test_method_name(self) -> None: + results = [0, 3, 0] + self.assertTrue(np.all(results == np.array([0, 3, 0]))) + + +if __name__ == "__main__": + unittest.main() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..7182914 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,36 @@ +[project] +name = "dessia_bot_template" +requires-python = ">= 3.9" + +[tool.ruff] +line-length = 120 +target-version = "py39" +exclude = [] + +[tool.ruff.lint] +preview = true +select = [ # https://docs.astral.sh/ruff/rules + "E4", "E7", "E9", # pycodestyle + "F", # Pyflakes + "B", # flake8-bugbear + "I", # isort + "N", # pep8-naming + "D", # pydocstyle documentation + "UP", # pyupgrade + "ANN001", # missing type annotation for function arguments + "ANN201", # missing type annotation for function return value + "PL", # pylint + "NPY", # NumPy-specific rules + "PERF", # Perflint + "RUF", # Ruff-specific rules +] + +[tool.ruff.lint.pydocstyle] +convention = "pep257" + +[tool.ruff.lint.per-file-ignores] +"tests/**/*.py" = ["D"] # documenting the unit tests is not necessary + +[tool.codespell] +skip = ["*.json", "*.html", "*.js", "*.css", ".c", ".h", ".cpp", ".hpp", "*.xml"] +ignore-words-list = ["dessia"] # words to ignore from codespell check diff --git a/python.gitignore b/python.gitignore deleted file mode 100644 index 73358ad..0000000 --- a/python.gitignore +++ /dev/null @@ -1,139 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - diff --git a/quickstart.py b/quickstart.py deleted file mode 100644 index b90b8ae..0000000 --- a/quickstart.py +++ /dev/null @@ -1,263 +0,0 @@ -import os -from typing import Tuple -import shutil - -from pathlib import Path - -from templates import manifest_template, readme_template, default_module_content, drone_template, test_template,\ - code_quality_template, code_pep8_template, code_pylint_template, setup_template - -parent_folder = Path(os.getcwd()).parent - - -print('=======================') -print(' DessiA Bot quickstart') -print('=======================\n') -print('This script will generate for you the files needed to create a python package respecting DessiA guidelines.') -print("If you don't understand a question or have no preference just type enter to have the default choice selected.") -print('Most questions have to be answered with y=yes or n=no. Default value if nothing is answered is written in capital\n') -input('Type any key to begin the process...') -print('') - - -def has_special_char(string: str) -> Tuple[bool, str]: - for char in ['&', 'é', '~', '"', ',', "'", '{', '(', '£', - ',', '-', '|', 'è', "`", 'ç', '^', ';', '$', - 'à', '@', ')', ']', '°', '=', '}', ':', 'µ' - '+', '*', '/', '.', '\\', '?', '!', '%', 'ù']: - if char in string: - return True, char - return False, '' - - -def enter_valid_name(target: str, default: str = None): - valid_name = False - n_retries = 0 - while not valid_name and n_retries < 10: - if default is None: - prompt = 'Enter {} name : '.format(target) - else: - prompt = 'Enter {} name (default : {}) : '.format(target, default) - name = input(prompt) - has_special, special_char = has_special_char(name) - if not name and default is not None: - name = default - - valid_name = (len(name) > 3 and name.islower() and not has_special) - if not valid_name: - n_retries += 1 - msg = '{} name is not valid.\n'.format(target) - msg += 'It must not contain caps nor special characters apart from "_"' - msg += 'and must be longer than 3 characters.\n' - msg += 'Please retry. ({}/10)'.format(n_retries) - print(msg) - if not valid_name: - msg = 'Maximum retries exceeded, {} name is not valid'.format(target) - raise ValueError(msg) - return name - - -package_name = enter_valid_name('Package') - -git_use = input('Do you want to use git in this project (eventually through a service like Github, Gitlab, Gitea, Gogs)?: (Y/n): ') -git_use = git_use.lower() != 'n' -if git_use: - done = input('Create a repository on your service (Github, Gitlab, Gitea, Gogs) and clone it on your computer. Press enter when done') - git_detected = False - while not git_detected: - project_path = input('Where is the git repo folder? current folder: {}: '.format(parent_folder)) - if not os.path.isabs(project_path): - project_path = os.path.join(parent_folder, project_path) - git_folder = os.path.join(project_path, '.git') - if os.path.isdir(git_folder): - print('{} is a valid git repo'.format(project_path)) - git_detected = True - else: - print('No .git subfolder found in {} Please retry.'.format(project_path)) - - - -else: - base_folder = input("Select parent folder in which the project will be generated (default: {}): ".format(parent_folder)) - if not base_folder: - base_folder = parent_folder - else: - if not os.path.exists(base_folder): - print('Creating base folder as it does not exists') - os.makedirs(base_folder) - print('Project will be created in folder {}'.format(base_folder)) - project_path = os.path.join(base_folder, package_name) - - if os.path.exists(project_path): - confirm = input('the folder {} already exists. Confirm to use existing folder (y/N): '.format(project_path)) - if confirm.lower() not in ['y', 'yes']: - raise ValueError('Aborting in using existing folder') - else: - os.mkdir(project_path) - -package_path = os.path.join(project_path, package_name) - -if not os.path.exists(package_path): - os.mkdir(package_path) - -assets_path = os.path.join(package_path, 'assets') -if not os.path.exists(assets_path): - os.mkdir(assets_path) - -shutil.copyfile('logo.png', os.path.join(assets_path, '{}.png'.format(package_name))) - - -setup_path = os.path.join(project_path, 'setup.py') -scripts_path = os.path.join(project_path, 'scripts') - -module_name = enter_valid_name('Module', 'core') -if not module_name: - module_name = 'core' - - -# shutil.copyfile('setup_template.py', setup_path) - -if not os.path.exists(scripts_path): - os.mkdir(scripts_path) - -init_path = os.path.join(package_path, '__init__.py') -if not os.path.exists(init_path): - init_file = open(init_path, 'x+') - init_file.writelines(["import pkg_resources\n", - "from .{} import *\n".format(module_name), - '__version__ = pkg_resources.require("{}")[0].version\n'.format(package_name)]) -else: - print('__init__.py already exists, skipping creation') - - -module_path = os.path.join(package_path, '{}.py'.format(module_name)) -if not os.path.exists(module_path): - module_file = open(module_path, 'x+') - module_file.write(default_module_content) -else: - print('base python module already exists, skipping creation') - -short_description = input('Enter a short description : ') -author_name = input('Enter your name : ') -author_mail = input('Enter your e-mail : ') -default_requirements = ['dessia_common>=0.7.2', 'volmdlr>=0.4.0'] -requirements = input("Enter required packages, separated by a coma (default : {})".format(default_requirements)) -python_version = input('Enter Python version (default : >=3.8) : ') -if not requirements: - requirements = default_requirements -else: - requirements = requirements.split(',') - -if not python_version: - python_version = ">=3.8" - -from_git_tags = input('Do you want to enable version from git tags? (Y/n): ') - -# Gitignore -create_gitignore = input('Do you want to create a python gitignore file? (Y/n): ') -create_gitignore = create_gitignore.lower() != 'n' - -gitignore_path = os.path.join(project_path, '.gitignore') -if create_gitignore: - shutil.copyfile('python.gitignore', gitignore_path) - -# README -create_readme = input('Do you want to create a README file? It will be used as long description. (Y/n): ') -create_readme = create_readme.lower() != 'n' - -readme_path = os.path.join(project_path, 'README.md') -if create_readme: - with open(readme_path, 'w') as f: - f.write(readme_template.substitute( - package_name=package_name, - author='{} ({})'.format(author_name, author_mail), - short_description=short_description, - )) - -# Tests -tests_dir = os.path.join(project_path, 'tests') -if not os.path.exists(tests_dir): - os.mkdir(tests_dir) - -for test_filename in ['coverage.py', 'ci_tests.py']: - test_file_path = os.path.join(tests_dir, test_filename) - shutil.copyfile(test_filename, test_file_path) - -test_path = os.path.join(tests_dir, 'test.py') -with open(test_path, 'w') as f: - f.write(test_template.substitute( - package_name=package_name, - )) - - -# Code quality -code_quality = input('Do you want to have some code quality checks? (Y/n): ') -code_quality = code_quality.lower() != 'n' - -if code_quality: - for filename in ['.pep8', '.pylintrc']: - cq_path = os.path.join(project_path, filename) - shutil.copyfile(filename, cq_path) - - for code_quality_filename, template_name in [('code_pep8.sh', code_pep8_template), - ('code_quality.sh', code_quality_template), - ('code_pylint.py', code_pylint_template)]: - # cq_path = os.path.join(package_path, code_quality_filename) - # shutil.copyfile(code_quality_filename, cq_path) - with open(os.path.join(project_path, code_quality_filename), 'w') as f: - f.write(template_name.substitute( - package_name=package_name, - )) - - -# CI -drone = input('Do you want to generate a .drone.yml file for drone.io CI? (Y/n): ') -drone = drone.lower() != 'n' - -if drone: - drone_path = os.path.join(project_path, '.drone.yml') - with open(drone_path, 'w') as f: - f.write(drone_template.substitute( - package_name=package_name)) - -# Writing setup file - -if from_git_tags.lower() == 'n': - version = "'0.0.1'" -else: - version = "get_version()" - -# setup_str += "\tname='{}',\n".format(package_name) -# setup_str += "\tdescription='{}',\n".format(short_description) -# if create_readme: -# setup_str += "\tlong_description=readme(),\n" -# setup_str += "\tlong_description_content_type='text/markdown',\n" -# else: -# setup_str += "\tlong_description='',\n" - -# setup_str += "\tauthor='{}',\n".format(author_name) -# setup_str += "\tauthor_email='{}',\n".format(author_mail) -# setup_str += "\tinstall_requires={},\n".format(requirements) -# setup_str += "\tpython_requires='{}',\n".format(python_version) -# setup_str += "\tpackages=find_packages(),\n" -# setup_str += ")" - -setup_str = setup_template.substitute(package_name=package_name, - version=version, - short_description = short_description, - author_name = author_name, - author_mail = author_mail, - requirements = requirements, - python_version = python_version) - -with open(setup_path, 'w') as setup_file: - setup_file.write(setup_str) - - -manifest_path = os.path.join(project_path, 'MANIFEST.in') -if not os.path.exists(manifest_path): - with open(manifest_path, 'w') as f: - f.write(manifest_template.substitute(package_name=package_name)) - - -print('Project generated to {}'.format(project_path)) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c2c9ca4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +configparser +requests diff --git a/setup_template.py b/setup_template.py deleted file mode 100644 index d9340d8..0000000 --- a/setup_template.py +++ /dev/null @@ -1,99 +0,0 @@ -from setuptools import setup, find_packages -import re -from os.path import dirname, isdir, join, exists -from subprocess import CalledProcessError, check_output - -tag_re = re.compile(r'\btag: %s([0-9][^,]*)\b') -version_re = re.compile('^Version: (.+)$', re.M) - - -def readme(): - with open('README.md') as f: - return f.read() - -def version_from_git_describe(version): - if version[0]=='v': - version = version[1:] - - # PEP 440 compatibility - number_commits_ahead = 0 - if '-' in version: - version, number_commits_ahead, commit_hash = version.split('-') - number_commits_ahead = int(number_commits_ahead) - - # print('number_commits_ahead', number_commits_ahead) - - split_versions = version.split('.') - if 'post' in split_versions[-1]: - suffix = split_versions[-1] - split_versions = split_versions[:-1] - else: - suffix = None - - for pre_release_segment in ['a', 'b', 'rc']: - if pre_release_segment in split_versions[-1]: - if number_commits_ahead > 0: - split_versions[-1] = str(split_versions[-1].split(pre_release_segment)[0]) - if len(split_versions) == 2: - split_versions.append('0') - if len(split_versions) == 1: - split_versions.extend(['0', '0']) - - split_versions[-1] = str(int(split_versions[-1])+1) - future_version = '.'.join(split_versions) - return '{}.dev{}'.format(future_version, number_commits_ahead) - else: - return '.'.join(split_versions) - - if number_commits_ahead > 0: - if len(split_versions) == 2: - split_versions.append('0') - if len(split_versions) == 1: - split_versions.extend(['0', '0']) - split_versions[-1] = str(int(split_versions[-1])+1) - split_versions = '.'.join(split_versions) - return '{}.dev{}'.format(split_versions, number_commits_ahead) - else: - if suffix is not None: - split_versions.append(suffix) - - return '.'.join(split_versions) - -# Just testing if get_version works well -assert version_from_git_describe('v0.1.7.post2') == '0.1.7.post2' -assert version_from_git_describe('v0.0.1-25-gaf0bf53') == '0.0.2.dev25' -assert version_from_git_describe('v0.1-15-zsdgaz') == '0.1.1.dev15' -assert version_from_git_describe('v1') == '1' -assert version_from_git_describe('v1-3-aqsfjbo') == '1.0.1.dev3' - -def get_version(): - # Return the version if it has been injected into the file by git-archive - version = tag_re.search('$Format:%D$') - if version: - return version.group(1) - - d = dirname(__file__) - pkg_info_path = join(d, 'PKG-INFO') - - if isdir(join(d, '.git')): - cmd = 'git describe --tags' - try: - version = check_output(cmd.split()).decode().strip()[:] - - except CalledProcessError: - raise RuntimeError('Unable to get version number from git tags: create a first v0.0.1 version to start!') - - return version_from_git_describe(version) - - elif exists(pkg_info_path): - # try to extract the version from the PKG-INFO file. - with open(pkg_info_path, 'r') as f: - version = version_re.search(f.read()).group(1) - else: - print('No version found from git tags nor from PKGINFO. defaulting to 0.0.1') - version='0.0.1' - - return version - - - diff --git a/template_inputs.ini b/template_inputs.ini new file mode 100644 index 0000000..4c95f28 --- /dev/null +++ b/template_inputs.ini @@ -0,0 +1,23 @@ +[GENERAL] +package_name = +short_description = A Specific python package for a technological issue. +long_description = A Python package using DessiA SDK tools and coding guidelines (https://documentation.dessia.io) + +[PYTHON_REQUIREMENTS] +required_packages = dessia_common>=0.18.0, volmdlr>=0.18.0, plot_data>=0.26.0 +python_version = >=3.9 + +[METADATA] +author = Operations-Team +email = support@dessia.io +package_url = + +[DOCUMENTATION] +GENERAL.package_name = This is the unique name of your Python package. It should be all lowercase and use underscores to separate words (e.g., my_package). (*) +GENERAL.short_description = A concise summary of what your package does. This will appear in package listings and should be clear and to the point. Aim for one sentence. +GENERAL.long_description = A more detailed description of your package. This can be a few paragraphs long and should explain the package’s features, use cases, and any important details. This will typically be included in the README.md file which can be updated after. +PYTHON_REQUIREMENTS.required_packages = A list of other Python packages that your package depends on. These dependencies will be automatically installed when your package is installed. List each package separated by a comma. +PYTHON_REQUIREMENTS.python_version = The minimum version of Python that your package is compatible with. Specify the version in the format >= followed by the version number. +METADATA.author = The name of the person or team responsible for maintaining the package. This should be the operations-team that will handle updates, support, and maintenance of the package. +METADATA.email = The contact email for the operations-team responsible for the package. This email should be monitored for any support requests, questions, or issues related to the package. +METADATA.package_url = This URL where the package source code will be created. Typically, this will be the URL of the repository hosting the package (e.g., a GitLab, GitHub, or Bitbucket repository), like: www.gitlab.com/dessia diff --git a/templates.py b/templates.py deleted file mode 100644 index 759ea53..0000000 --- a/templates.py +++ /dev/null @@ -1,382 +0,0 @@ -import string - -manifest_template = string.Template('''recursive-include $package_name/assets *.html *.js *ts *.jpg *.png -recursive-include scripts *.py -recursive-include $package_name/models *.py -prune .git -''') - -readme_template = string.Template('''# $package_name - -$package_name is a Python package using DessiA SDK and DessiA coding guidelines (https://documentation.dessia.tech) - -$short_description - -author: $author - -## Installation - -Move to the folder to next to setup.py and -```bash -python setup.py install -``` - -## Usage - -''') - - -default_module_content = '''#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -Documentation of module goes here -""" - -import dessia_common as dc -import volmdlr as vm -import volmdlr.primitives3d as p3d - -''' - -test_template = string.Template('''#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -Basic test -""" - -import $package_name - -''') - - - -drone_template = string.Template('''--- -kind: pipeline -type: docker -name: default - -steps: -- name: check code complexity, docs & code quality - image: python:3.9 - commands: - - pip install radon pydocstyle pylint - - ./code_quality.sh - - python code_pylint.py - -- name: check pep8 formatting - image: python:3.9 - when: - branch: master - commands: - - git fetch --tags - - pip3 install -U pip autopep8 - - bash code_pep8.sh - -- name: install, run scripts and build doc - image: python:3.9 - commands: - - git fetch --tags - - python setup.py install - - pip install coverage - - cd tests - - coverage run --source $package_name ci_tests.py - - coverage json - - python coverage.py - - coverage report - -- name: develop - image: python:3.9 - commands: - - python setup.py develop - -''') - -code_quality_template = string.Template(''' -#!/bin/bash - -max_pydoc_errors=10 - -cq_result=$$(radon cc --min E -e *pyx $package_name) -echo $$cq_result -if [[ "$$cq_result" ]]; - then - echo "Error in code quality check, run radon to simplify functions">&2; - exit 64; - -fi; - -nb_pydoc_errors=$$(pydocstyle --count --ignore D400,D415,D404,D212,D205,D200,D203,D401,D210 $package_name *.py | tail -1) -echo "$$nb_pydoc_errors pydoc errors, limit is $$max_pydoc_errors" -if [[ "$$nb_pydoc_errors" -gt "$$max_pydoc_errors" ]]; - then - echo "Error in doc quality check, run pydocstyle to correct docstrings">&2; - exit 64; - else - echo "You can lower number of pydoc errors to $$nb_pydoc_errors (actual $$max_pydoc_errors)" -fi; -''') - -code_pylint_template = string.Template(''' - -""" -Read pylint errors to see if number of errors does not exceed specified limits -v1.0 -""" - -from pylint.lint import Run - -MIN_NOTE = 8.85 - -UNWATCHED_ERRORS = ['fixme', - 'trailing-whitespace', - 'import-error' - ] - - -MAX_ERROR_BY_TYPE = { - # No tolerance errors - 'consider-using-f-string': 0, - 'no-else-return': 0, - 'arguments-differ': 0, - 'no-member': 0, - 'too-many-locals': 0, - 'wrong-import-order': 0, - 'too-many-branches': 0, - 'unused-import': 0, - 'unused-argument': 0, - 'cyclic-import': 0, - 'no-self-use': 0, - 'unused-variable': 0, - 'too-many-arguments': 0, - 'unnecessary-comprehension': 0, - 'no-value-for-parameter': 0, - 'too-many-return-statements': 0, - 'raise-missing-from': 0, - 'consider-merging-isinstance': 0, - 'abstract-method': 0, - 'import-outside-toplevel': 0, - 'too-many-instance-attributes': 0, - 'consider-iterating-dictionary': 0, - 'attribute-defined-outside-init': 0, - 'simplifiable-if-expression': 0, - 'redefined-builtin': 0, - 'broad-except': 0, - 'unspecified-encoding': 0, - 'consider-using-get': 0, - 'undefined-loop-variable': 0, - 'consider-using-with': 0, - 'eval-used': 0, - 'too-many-nested-blocks': 0, - 'bad-staticmethod-argument': 0, - 'too-many-public-methods': 0, - 'consider-using-generator': 0, - 'too-many-statements': 0, - 'chained-comparison': 0, - 'wildcard-import': 0, - 'use-maxsplit-arg': 0, - 'arguments-renamed': 0, - 'ungrouped-imports': 0, - 'super-init-not-called': 0, - 'superfluous-parens': 0, - 'unused-wildcard-import': 0, - 'consider-using-enumerate': 0, - 'undefined-variable': 0, - 'function-redefined': 0, - 'inconsistent-return-statements': 0, - 'unexpected-special-method-signature': 0, - 'too-many-lines': 0, - 'bare-except': 0, - } - -import os -import sys -f = open(os.devnull, 'w') - -old_stdout = sys.stdout -sys.stdout = f - -results = Run(['$package_name', '--output-format=json', '--reports=no'], do_exit=False) -# `exit` is deprecated, use `do_exit` instead -sys.stdout = old_stdout - -PYLINT_OBJECTS = True -if hasattr(results.linter.stats,'global_note'): - pylint_note = results.linter.stats.global_note - PYLINT_OBJECT_STATS = True -else: - pylint_note = results.linter.stats['global_note'] - PYLINT_OBJECT_STATS = False - -print('Pylint note: ', pylint_note) -assert pylint_note >= MIN_NOTE -print('You can increase MIN_NOTE in pylint to {} (actual: {})'.format(pylint_note, - MIN_NOTE)) - - -def extract_messages_by_type(type_): - return [m for m in results.linter.reporter.messages if m.symbol == type_] - - -# uncontrolled_errors = {} -error_detected = False - -if PYLINT_OBJECT_STATS: - stats_by_msg = results.linter.stats.by_msg -else: - stats_by_msg = results.linter.stats['by_msg'] - -for error_type, number_errors in stats_by_msg.items(): - if error_type not in UNWATCHED_ERRORS: - if error_type in MAX_ERROR_BY_TYPE: - max_errors = MAX_ERROR_BY_TYPE[error_type] - else: - max_errors = 0 - - if number_errors > max_errors: - error_detected = True - print('Fix some {} errors: {}/{}'.format(error_type, - number_errors, - max_errors)) - for message in extract_messages_by_type(error_type): - print('{} line {}: {}'.format(message.path, message.line, message.msg)) - elif number_errors < max_errors: - print('You can lower number of {} to {} (actual {})'.format( - error_type, number_errors, max_errors)) - - -if error_detected: - raise RuntimeError('Too many errors. Run pylint $package_name to get the errors') - -''') - -code_pep8_template = string.Template('''#!/bin/bash -# check pep8 formatting for all files - -PEP8_CMD_TO_RUN='python3 -m autopep8 -i $package_name *.py' - -DETECTED_CHANGES=$$(python3 -m autopep8 -d $package_name *.py) -if [[ -n "$$DETECTED_CHANGES" ]] - then - echo -e "\npep8 non conforming changes detected, please run :\n" - echo -e "\t$$PEP8_CMD_TO_RUN\n" - echo -e "& stage your changes before pushing" - exit 1 -fi - -exit 0 -''') - - -setup_template = string.Template(''' -from setuptools import setup, find_packages -import re -from os.path import dirname, isdir, join, exists -from subprocess import CalledProcessError, check_output - -tag_re = re.compile(r'\btag: %s([0-9][^,]*)\b') -version_re = re.compile('^Version: (.+)$$', re.M) - - -def readme(): - with open('README.md') as f: - return f.read() - -def version_from_git_describe(version): - if version[0]=='v': - version = version[1:] - - # PEP 440 compatibility - number_commits_ahead = 0 - if '-' in version: - version, number_commits_ahead, commit_hash = version.split('-') - number_commits_ahead = int(number_commits_ahead) - - # print('number_commits_ahead', number_commits_ahead) - - split_versions = version.split('.') - if 'post' in split_versions[-1]: - suffix = split_versions[-1] - split_versions = split_versions[:-1] - else: - suffix = None - - for pre_release_segment in ['a', 'b', 'rc']: - if pre_release_segment in split_versions[-1]: - if number_commits_ahead > 0: - split_versions[-1] = str(split_versions[-1].split(pre_release_segment)[0]) - if len(split_versions) == 2: - split_versions.append('0') - if len(split_versions) == 1: - split_versions.extend(['0', '0']) - - split_versions[-1] = str(int(split_versions[-1])+1) - future_version = '.'.join(split_versions) - return '{}.dev{}'.format(future_version, number_commits_ahead) - else: - return '.'.join(split_versions) - - if number_commits_ahead > 0: - if len(split_versions) == 2: - split_versions.append('0') - if len(split_versions) == 1: - split_versions.extend(['0', '0']) - split_versions[-1] = str(int(split_versions[-1])+1) - split_versions = '.'.join(split_versions) - return '{}.dev{}'.format(split_versions, number_commits_ahead) - else: - if suffix is not None: - split_versions.append(suffix) - - return '.'.join(split_versions) - -# Just testing if get_version works well -assert version_from_git_describe('v0.1.7.post2') == '0.1.7.post2' -assert version_from_git_describe('v0.0.1-25-gaf0bf53') == '0.0.2.dev25' -assert version_from_git_describe('v0.1-15-zsdgaz') == '0.1.1.dev15' -assert version_from_git_describe('v1') == '1' -assert version_from_git_describe('v1-3-aqsfjbo') == '1.0.1.dev3' - -def get_version(): - # Return the version if it has been injected into the file by git-archive - version = tag_re.search('$$Format:%D$$') - if version: - return version.group(1) - - d = dirname(__file__) - pkg_info_path = join(d, 'PKG-INFO') - - if isdir(join(d, '.git')): - cmd = 'git describe --tags' - try: - version = check_output(cmd.split()).decode().strip()[:] - - except CalledProcessError: - raise RuntimeError('Unable to get version number from git tags: create a first v0.0.1 version to start!') - - return version_from_git_describe(version) - - elif exists(pkg_info_path): - # try to extract the version from the PKG-INFO file. - with open(pkg_info_path, 'r') as f: - version = version_re.search(f.read()).group(1) - else: - print('No version found from git tags nor from PKGINFO. defaulting to 0.0.1') - version='0.0.1' - - return version - -setup(version=$version, - name='$package_name', - description='$short_description', - long_description=readme(), - long_description_content_type='text/markdown', - author='$author_name', - author_email='$author_mail', - install_requires=$requirements, - python_requires='$python_version', - packages=find_packages() -) - -''')