Skip to content

Header and License

Ludwig Hülk edited this page Feb 7, 2018 · 10 revisions

Taken and adapted from the oemof developer group

Python files:

"""Title of the script.
This is the docstring for the example.py module.  Modules names should
have short, all-lowercase names.  The module name may have underscores if
this improves readability.
Every module should have a docstring at the very top of the file.  The
module's docstring may extend over multiple lines.  If your docstring does
extend over multiple lines, the closing three quotation marks must be on
a line by itself, preferably preceded by a blank line.
"""

__copyright__ = "NEXT ENERGY" OR "Reiner Lemoine Institut" OR "ZNES"
__license__ = "GNU Affero General Public License Version 3 (AGPL-3.0)"
__url__ = "https://github.com/openego/data_processing/blob/master/LICENSE"
__author__ = "author1, author2"

import some_package

my code....

SQL and other:

/*
Title of the script.
A description of the module (short but could be more than one line).
Modules names should have short, all-lowercase names. 
The module name may have underscores if this improves readability.

Input
-----
schema.table
schema.table2

Output
------
schema.table

__copyright__ = "NEXT ENERGY" OR "Reiner Lemoine Institut" OR "ZNES"
__license__ = "GNU Affero General Public License Version 3 (AGPL-3.0)"
__url__ = "https://github.com/openego/data_processing/blob/master/LICENSE"
__author__ = "author1, author2"
*/

my code....
Clone this wiki locally