Skip to content
Snippets Groups Projects
Commit 25ad9de4 authored by Florian Garzon's avatar Florian Garzon
Browse files

edited license and readme

parent 0500f985
Branches
No related tags found
No related merge requests found
MIT License
Copyright (c) 2021 Florian Ladstädter
Copyright (c) 2021 Florian Garzon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
......
# minimal_example
# tempanomaly
A sample project to show one simple, and not necessarily the best,
way of packaging a Python project. The project can be installed
in your environment (preferably virtual environment) using `pip`.
It contains a very simple sample configuration for a Python project
with the following features:
1. A command line interface
2. An installable shell script
3. An example of how to include data files in an installable project
4. An example of how to describe dependencies to other Python projects
It provides the following shell script: `minimal_example`.
For usage information, type `minimal_example --help`.
A simple program that plot a time series for the temperature (T, T_max, T_min)
and temperature anomalies for a selectable time span at the University of Graz.
The data used was downloaded from ZAMG
(https://data.hub.zamg.ac.at/dataset/klima-daily).
## Installation
......@@ -44,23 +34,4 @@ E.g., with `conda`:
conda create --name mynewenv python
conda activate mynewenv
python -m pip install -e .
```
## Notes
Python packaging is evolving towards new packaging tools. This example project is using
the "old" way of doing packaging, due to its relative simplicity, and because the
transition to the "new" way is still ongoing. For the future, please be aware that
Python packages should contain a `pyproject.toml` file containing all relevant
information needed for building and deploying a project. There are several tools
already available dealing with the "new" way, most prominently maybe `poetry`.
If you are about to start a new project of your own, do have a look at `poetry`.
Some relevant links:
- pep-517: https://www.python.org/dev/peps/pep-0517/
- pep-621: https://www.python.org/dev/peps/pep-0621/
- https://python-poetry.org/
- https://cjolowicz.github.io/posts/hypermodern-python-01-setup/
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment