Commit 89f881c3 authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Moved the repo to the sec23 namespace.

parent e652bcbd
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
#
# SPDX-License-Identifier: CC0-1.0
comment in file:
- 'requirements\.txt'
- '.*\.nix$'
- '.*\.sh$'
- '.*\.py$'
- '.*\.yml$'
- '.*\.yaml$'
- '.*\.html$'
- '.*\.toml$'
- '.*\.md$'
- '.*\.css$'
- '.*\.gitignore$'
- '.*\.gitmodules$'
- '.*Dockerfile.*$'
description: 'pymagglobal is a python interface for global geomagnetic field models.'
ignore paths:
# git
- '.*\.git/.*'
licenses:
default:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'GPL-3.0-or-later'
Insignificant:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'CC0-1.0'
files:
# Matching the data folder didn't work, so I list all files...
- 'ARCH10k\.1'
- 'arhimag1k'
- 'CALS10k\.2'
- 'GGF100k'
- 'gufm1'
- 'HFM\.OL1\.A1'
- 'LSMOD\.2'
- 'pfm9k\.1a'
- '.*\.txt$'
- '.*\.md$'
- '.*\.yml$'
- '.*\.nix$'
- '.*\.obj$'
- '.*\.html$'
- '.*\.gitignore'
- '.*\.jinja2'
Software:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'GPL-3.0-or-later'
files:
# Python
- '.*\.py$'
# Shell
- '.*\.sh$'
# Dockerfile
- '.*Dockerfile*$'
# CSS
- '.*\.css$'
# jupyter notebooks
- '.*\.ipynb$'
Data:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'GPL-3.0-or-later'
files:
# Shell
- '.*\.sh$'
# CSS
- '.*\.css$'
[<SOFTWARE NAME>]
[<SOFTWARE DESCRIPTION>]
{% for copyright_line in copyright_lines %}
{{ copyright_line }}
{% endfor %}
{% for expression in spdx_expressions %}
SPDX-License-Identifier: {{ expression }}
{% endfor %}
This Program was developed within the context of the following
publicly funded projects or measures:
- DFG (German Research Foundation), grant 388291411
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, Version 3 or later.
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 can find a copy of the license in the LICENSES folder.
If not, see <http://www.gnu.org/licenses/>.
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
SPDX-License-Identifier: CC0-1.0
\ No newline at end of file
{% for copyright_line in copyright_lines %}
{{ copyright_line }}
{% endfor %}
{% for expression in spdx_expressions %}
SPDX-License-Identifier: {{ expression }}
{% endfor %}
\ No newline at end of file
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
SPDX-License-Identifier: CC0-1.0
\ No newline at end of file
<!--
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
SPDX-License-Identifier: CC0-1.0
-->
## License
Copyright © [<YEAR>] [<COPYRIGHT>]
This work is licensed under the following license(s):
[<SCOPE>]
Please see the individual files for more accurate information.
> **Hint:** We provided the copyright and license information in accordance to the [REUSE Specification 3.0](https://reuse.software/spec/).
\ No newline at end of file
# pymagglobal
# pymagglobal is a python interface for global geomagnetic field models.
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
#
# SPDX-License-Identifier: CC0-1.0
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This Program was developed within the context of the following
# publicly funded projects or measures:
# - DFG (German Research Foundation), grant 388291411
#
# 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, Version 3 or later.
#
# 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 can find a copy of the license in the LICENSES folder.
# If not, see <http://www.gnu.org/licenses/>.
title = "gitleaks config"
[[rules]]
description = "AWS Manager ID"
regex = '''(A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}'''
tags = ["key", "AWS"]
[[rules]]
description = "AWS Secret Key"
regex = '''(?i)aws(.{0,20})?(?-i)['\"][0-9a-zA-Z\/+]{40}['\"]'''
tags = ["key", "AWS"]
[[rules]]
description = "AWS MWS key"
regex = '''amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'''
tags = ["key", "AWS", "MWS"]
[[rules]]
description = "Facebook Secret Key"
regex = '''(?i)(facebook|fb)(.{0,20})?(?-i)['\"][0-9a-f]{32}['\"]'''
tags = ["key", "Facebook"]
[[rules]]
description = "Facebook Client ID"
regex = '''(?i)(facebook|fb)(.{0,20})?['\"][0-9]{13,17}['\"]'''
tags = ["key", "Facebook"]
[[rules]]
description = "Twitter Secret Key"
regex = '''(?i)twitter(.{0,20})?[0-9a-z]{35,44}'''
tags = ["key", "Twitter"]
[[rules]]
description = "Twitter Client ID"
regex = '''(?i)twitter(.{0,20})?[0-9a-z]{18,25}'''
tags = ["client", "Twitter"]
[[rules]]
description = "Github"
regex = '''(?i)github(.{0,20})?(?-i)[0-9a-zA-Z]{35,40}'''
tags = ["key", "Github"]
[[rules]]
description = "LinkedIn Client ID"
regex = '''(?i)linkedin(.{0,20})?(?-i)[0-9a-z]{12}'''
tags = ["client", "LinkedIn"]
[[rules]]
description = "LinkedIn Secret Key"
regex = '''(?i)linkedin(.{0,20})?[0-9a-z]{16}'''
tags = ["secret", "LinkedIn"]
[[rules]]
description = "Slack"
regex = '''xox[baprs]-([0-9a-zA-Z]{10,48})?'''
tags = ["key", "Slack"]
[[rules]]
description = "Asymmetric Private Key"
regex = '''-----BEGIN ((EC|PGP|DSA|RSA|OPENSSH) )?PRIVATE KEY( BLOCK)?-----'''
tags = ["key", "AsymmetricPrivateKey"]
[[rules]]
description = "Google API key"
regex = '''AIza[0-9A-Za-z\\-_]{35}'''
tags = ["key", "Google"]
[[rules]]
description = "Google (GCP) Service Account"
regex = '''"type": "service_account"'''
tags = ["key", "Google"]
[[rules]]
description = "Heroku API key"
regex = '''(?i)heroku(.{0,20})?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'''
tags = ["key", "Heroku"]
[[rules]]
description = "MailChimp API key"
regex = '''(?i)(mailchimp|mc)(.{0,20})?[0-9a-f]{32}-us[0-9]{1,2}'''
tags = ["key", "Mailchimp"]
[[rules]]
description = "Mailgun API key"
regex = '''((?i)(mailgun|mg)(.{0,20})?)?key-[0-9a-z]{32}'''
tags = ["key", "Mailgun"]
[[rules]]
description = "PayPal Braintree access token"
regex = '''access_token\$production\$[0-9a-z]{16}\$[0-9a-f]{32}'''
tags = ["key", "Paypal"]
[[rules]]
description = "Picatic API key"
regex = '''sk_live_[0-9a-z]{32}'''
tags = ["key", "Picatic"]
[[rules]]
description = "SendGrid API Key"
regex = '''SG\.[\w_]{16,32}\.[\w_]{16,64}'''
tags = ["key", "SendGrid"]
[[rules]]
description = "Slack Webhook"
regex = '''https://hooks.slack.com/services/T[a-zA-Z0-9_]{8}/B[a-zA-Z0-9_]{8}/[a-zA-Z0-9_]{24}'''
tags = ["key", "slack"]
[[rules]]
description = "Stripe API key"
regex = '''(?i)stripe(.{0,20})?[sr]k_live_[0-9a-zA-Z]{24}'''
tags = ["key", "Stripe"]
[[rules]]
description = "Square access token"
regex = '''sq0atp-[0-9A-Za-z\-_]{22}'''
tags = ["key", "square"]
[[rules]]
description = "Square OAuth secret"
regex = '''sq0csp-[0-9A-Za-z\\-_]{43}'''
tags = ["key", "square"]
[[rules]]
description = "Twilio API key"
regex = '''(?i)twilio(.{0,20})?SK[0-9a-f]{32}'''
tags = ["key", "twilio"]
[[rules]]
description = "Generic Credential"
regex = '''(?i)(dbpasswd|dbuser|dbname|dbhost|api_key|apikey|secret|key|api|password|user|guid|hostname|pw|auth)(.{0,20})?['|"]([0-9a-zA-Z-_\/+!{}/=]{4,120})['|"]'''
tags = ["key", "API", "generic"]
[allowlist]
description = "Allowlisted files"
files = ['''.*gitleaks_config.toml$''', '''(.*?)(jpg|gif|doc|pdf|bin)$''', '''(go.mod|go.sum)$''']
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
#
# SPDX-License-Identifier: CC0-1.0
exclude:
- 'docs/.*'
- 'tests/.*'
- 'public/.*'
- 'out/.*'
- 'nix/.*'
- 'examples/.*'
- 'dat/.*'
manual dependency config:
Python:
# software itself
- import name: 'pymagglobal'
pkg name: 'pymagglobal'
ignore: True
# for installing only
- import name: 'setuptools'
pkg name: 'setuptools'
ignore: True
# for docs only
- import name: 'sphinx'
pkg name: 'sphinx'
ignore: True
# renaming because import name differs from pkg name
# for tests only
- import name: 'pyfield'
pkg name: 'pyfield'
version: '0.1.3i'
licenses:
- 'GPL-3.0-or-later'
- import name: 'orthopoly'
pkg name: 'orthopoly'
version: '0.7'
licenses:
- 'MIT'
- import name: 'packaging'
pkg name: 'packaging'
version: '20.7'
licenses:
- 'Apache-2.0'
- 'BSD-2-Clause'
# Software Quality Report
> **Note:** This report is automatically generated by [Software Quality Assurance](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)
## Table of Content
* [Meta Data](#meta-data)
* [Completed Services](#completed-services)
* [Apply License](#apply-license)
* [Check Credentials](#check-credentials)
* [List Authors](#list-authors)
* [List Used Languages](#list-used-languages)
* [List Used Licenses](#list-used-licenses)
* [Reuse Lint](#reuse-lint)
## Meta Data
**Software Name:** pymagglobal
**Software Location:** [gitext](gitext.gfz-potsdam.de/arthus/pymagglobal)
**Last Commit:** 723d86a6263f96cc598f6d48669c2b5c272271ed
**Report Time:** 30/11/2020 14:22:23 UTC
**Report Version:** 0.6.0
## Completed Services
### Apply License
> **Description: Adds license headers to files, downloads license texts and adds a license entry to the README**
**Successfully applied the licenses**
### Check Credentials
> **Description: Prints the result of [gitleaks](https://github.com/zricethezav/gitleaks)**
**No leaks detected.**
### List Authors
> **Description: Lists all people that committed to this config.**
* [Arthus](mailto:arthus@gfz-potsdam.de)
* [GitLab CI:arthus/pymagglobal](mailto:pymagglobal_software-quality-assurance@gitext.gfz-potsdam.de)
* [Maximilian Schanner](mailto:arthus@gfz-potsdam.de)
* [Stefan Mauerberger](mailto:mauerber@uni-potsdam.de)
### List Used Languages
> **Description: Detects used programming languages with [linguist](https://github.com/github/linguist)**
|Language|Percentage|
|---|---|
|Roff|97.88|
|Python|1.95|
|Nix|0.15|
|HTML|0.03|
### List Used Licenses
> **Description: Generates a list of dependencies and their license.**
#### found licenses
|license|libraries|
|---|---|
|Apache-2.0 AND BSD-2-Clause|Python / packaging / user config|
|BSD|Python / numpy / 1.19.2 <br> Python / scipy / 1.5.2|
|GPL-3.0-or-later|Python / pyfield / user config|
|LGPLv3|Python / cartopy / 0.18.0|
|MIT|Python / orthopoly / user config|
|PSF|Python / matplotlib / 3.3.2|
|Python-2.0|Python / argparse / base lib <br> Python / codecs / base lib <br> Python / os / base lib <br> Python / sys / base lib <br> Python / warnings / base lib|
#### errors
##### Python
**python**
* PyPi API error: 404 returned by https://pypi.org/pypi/python/3.7.9/json
### Reuse Lint
> **Description: Prints the result of the [reuse](https://reuse.software/spec/) linter.**
#### SUMMARY
* Bad licenses:
* Deprecated licenses:
* Licenses without file extension:
* Missing licenses:
* Unused licenses:
* Used licenses: CC0-1.0, GPL-3.0-or-later
* Read errors: 0
* Files with copyright information: 37 / 37
* Files with license information: 37 / 37
Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)
...@@ -15,7 +15,7 @@ By default, `pymagglobal` includes several models. Use ...@@ -15,7 +15,7 @@ By default, `pymagglobal` includes several models. Use
```console ```console
$ pymagglobal --list-models $ pymagglobal --list-models
``` ```
to get a list of these default models or go to [pymagglobal/dat](https://gitext.gfz-potsdam.de/arthus/pymagglobal/-/tree/master/pymagglobal/dat) for further information. Using to get a list of these default models or go to [pymagglobal/dat](https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal/-/tree/master/pymagglobal/dat) for further information. Using
```console ```console
$ pymagglobal ... <path/to/your_model> $ pymagglobal ... <path/to/your_model>
``` ```
...@@ -44,7 +44,7 @@ $ nix-shell ...@@ -44,7 +44,7 @@ $ nix-shell
from within the `pymagglobal` root directory. You may also use the nix-expression [pymagglobal.nix] to include `pymagglobal` in your own environments. from within the `pymagglobal` root directory. You may also use the nix-expression [pymagglobal.nix] to include `pymagglobal` in your own environments.
## Documentation ## Documentation
Check out the extended documention [here](http://arthus.gitext-pages.gfz-potsdam.de/pymagglobal). From the command line, you can use `pymagglobal` to get various results from the models. For example, Check out the extended documention [here](https://sec23.gitext-pages.gfz-potsdam.de/korte/pymagglobal). From the command line, you can use `pymagglobal` to get various results from the models. For example,
```console ```console
$ pymagglobal dipole gufm1 $ pymagglobal dipole gufm1
``` ```
...@@ -170,4 +170,4 @@ This work is licensed under the following license(s): ...@@ -170,4 +170,4 @@ This work is licensed under the following license(s):
Please see the individual files for more accurate information. Please see the individual files for more accurate information.
> **Hint:** We provided the copyright and license information in accordance to the [REUSE Specification 3.0](https://reuse.software/spec/). > **Hint:** We provided the copyright and license information in accordance to the [REUSE Specification 3.0](https://reuse.software/spec/).
\ No newline at end of file
...@@ -69,7 +69,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -69,7 +69,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# Add external links to source code # Add external links to source code
def linkcode_resolve(domain, info): def linkcode_resolve(domain, info):
'''Returns external links to the source of objects''' '''Returns external links to the source of objects'''
url = 'https://gitext.gfz-potsdam.de/arthus/pymagglobal' url = 'https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal'
filename = info['module'].replace('.', '/') + '.py' filename = info['module'].replace('.', '/') + '.py'
if info['fullname'] in core_members: if info['fullname'] in core_members:
return url + '/-/tree/master/' + info['module'] + '/core.py' return url + '/-/tree/master/' + info['module'] + '/core.py'
......
...@@ -24,7 +24,7 @@ Installation ...@@ -24,7 +24,7 @@ Installation
$ pip install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple $ pip install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
See also `here <https://gitext.gfz-potsdam.de/arthus/pymagglobal#installation>`_ and `here <https://gitext.gfz-potsdam.de/arthus/pymagglobal#testing>`_. See also `here <https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal#installation>`_ and `here <https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal#testing>`_.
.. include:: ../pymagglobal/dat/README.rst .. include:: ../pymagglobal/dat/README.rst
...@@ -54,4 +54,4 @@ Indices and tables ...@@ -54,4 +54,4 @@ Indices and tables
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`
* `Repository <https://gitext.gfz-potsdam.de/arthus/pymagglobal/>`_ * `Repository <https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal/>`_
...@@ -83,7 +83,7 @@ class ListModelsAction(argparse.Action): ...@@ -83,7 +83,7 @@ class ListModelsAction(argparse.Action):
print(f'Currently available models are:') print(f'Currently available models are:')
for it in models_list: for it in models_list:
print(it) print(it)
print(f'Visit https://gitext.gfz-potsdam.de/arthus/pymagglobal/' print(f'Visit https://gitext.gfz-potsdam.de/sec23/korte/pymagglobal/'
f'-/tree/master/pymagglobal/dat for detailed information.') f'-/tree/master/pymagglobal/dat for detailed information.')
parser.exit() parser.exit()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment