Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
tempanomaly
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Garzon, Florian
tempanomaly
Commits
25ad9de4
Commit
25ad9de4
authored
3 years ago
by
Florian Garzon
Browse files
Options
Downloads
Patches
Plain Diff
edited license and readme
parent
0500f985
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
LICENSE
+1
-1
1 addition, 1 deletion
LICENSE
README.md
+6
-35
6 additions, 35 deletions
README.md
with
7 additions
and
36 deletions
LICENSE
+
1
−
1
View file @
25ad9de4
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
...
...
This diff is collapsed.
Click to expand it.
README.md
+
6
−
35
View file @
25ad9de4
#
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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment