-
Notifications
You must be signed in to change notification settings - Fork 0
/
template_inputs.ini
23 lines (20 loc) · 1.99 KB
/
template_inputs.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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