Skip to content
Snippets Groups Projects
Commit d06d6120 authored by Klaas Kliffen's avatar Klaas Kliffen :satellite:
Browse files

Update pipeline and add package skeleton

parent ef2f9616
No related branches found
No related tags found
No related merge requests found
Pipeline #39007 passed with warnings
Stage: lint
Stage: test
Stage: package
Stage: integration
Show whitespace changes
Inline Side-by-side
Showing
with 378 additions and 120 deletions
.gitignore 0 → 100644
+ 2
− 0
View file @ d06d6120
dist/*
*.egg-info
.gitlab-ci.yml
+ 113
− 38
View file @ d06d6120
default: default:
image: python:3.10-slim image: python:3.7 # minimum supported version
# Make sure each step is executed in a virtual environment with some basic dependencies present
before_script:
- python --version # For debugging
- python -m venv venv
- source venv/bin/activate
- python -m pip install --upgrade pip
# install common packages required for linting, building, docs etc.
- pip install --upgrade black build flake8 pylint setuptools sphinx twine wheel
cache:
paths:
- .cache/pip
- venv/
stages: stages:
- lint - lint
# check if this needs to be a separate step
# - build_extensions
- test - test
- build - package
- integration
- publish # publish instead of deploy - publish # publish instead of deploy
# Caching of dependencies to speed up builds # Caching of dependencies to speed up builds
variables: variables:
PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
cache:
paths:
- .cache/pip
- venv/
# Make sure each step is executed in a virtual environment with some basic dependencies present
before_script:
- python --version # For debugging
- pip install --upgrade virtualenv twine wheel pipenv black flake8 # common packaging requirements
- virtualenv venv --system-site-packages #provide the installed packages
- source venv/bin/activate
run_black: run_black:
stage: lint stage: lint
script: script:
- echo "run black" - python -m black --version
- python -m black --check .
allow_failure: true
run_flake8: run_flake8:
stage: lint stage: lint
script: script:
- echo "run flake8" - python -m flake8 --version
- python -m flake8
allow_failure: true
run_pylint:
stage: lint
script:
- python -m pylint --version
- python -m pylint map
allow_failure: true
# build_extensions:
# stage: build_extensions
# script:
# - echo "build fortran/c/cpp extension source code"
run_unit_tests: run_unit_tests:
stage: test stage: test
script: script:
- echo "run python unit tests" - pip install -r requirements.txt
- echo "run python unit tests /w coverage"
package_files: package_files:
stage: build stage: package
# add storing of the build artefact artifacts:
expire_in: 1w
paths:
- dist/*
script:
- python -m build # or something similar
package_docs:
stage: package
artifacts:
expire_in: 1w
paths:
- docs/* # update path to match the dest dir for documentation
script:
- echo "build and collect docs"
run_integration_tests:
stage: integration
needs:
- package_files
script: script:
- echo "python setup.py sdist bdist_wheel" # or something similar - echo "make sure to move out of source dir"
- echo "install package from filesystem (or use the artefact)"
- echo "run against foreign systems (e.g. databases, cwl etc.)"
publish_on_gitlab: publish_on_gitlab:
stage: publish stage: publish
environment: gitlab environment: gitlab
needs:
- package_files
when: manual
rules:
- if: $CI_COMMIT_TAG
script: script:
- echo "run twine for gitlab" - echo "run twine for gitlab"
# - sed -i "s/BUILD_ID/.dev${CI_JOB_ID}/g" VERSION
# - python setup.py sdist bdist_wheel # todo replace this with reading the build artefact
# - | # - |
# TWINE_PASSWORD=${CI_JOB_TOKEN} \ # TWINE_PASSWORD=${CI_JOB_TOKEN} \
# TWINE_USERNAME=gitlab-ci-token \ # TWINE_USERNAME=gitlab-ci-token \
# python -m twine upload \ # python -m twine upload \
# --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/* # --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
publish_on_pipy: publish_on_test_pypi:
stage: publish stage: publish
environment: pipy environment: pypi-test
needs:
- package_files
when: manual
rules:
- if: $CI_COMMIT_TAG
script: script:
- echo "run twine for pipy" - echo "run twine for test pypi"
# - sed -i "s/BUILD_ID/.dev${CI_JOB_ID}/g" VERSION
# - python setup.py sdist bdist_wheel # todo replace this with reading the build artefact from `package_file`` step
# - | # - |
# TWINE_PASSWORD=${PIPY_TOKEN} \ # TWINE_PASSWORD=${PIPY_TOKEN} \
# TWINE_USERNAME=${PIPY_USERNAME} \ # TWINE_USERNAME=${PIPY_USERNAME} \
# TODO: replace URL with a pipy URL
# python -m twine upload \ # python -m twine upload \
# --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/* # --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
publish_on_pypi:
stage: publish
environment: pypi
needs:
- package_files
when: manual
rules:
- if: $CI_COMMIT_TAG
script:
- echo "run twine for pypi"
# - |
# TWINE_PASSWORD=${PIPY_TOKEN} \
# TWINE_USERNAME=${PIPY_USERNAME} \
# TODO: replace URL with a pipy URL # TODO: replace URL with a pipy URL
# python -m twine upload \
# --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
publish_to_readthedocs:
stage: publish
environment: readthedocs
needs:
- package_docs
when: manual
rules:
- if: $CI_COMMIT_TAG
script:
- echo "scp docs/* ???"
.vscode/settings.json 0 → 100644
+ 3
− 0
View file @ d06d6120
{
"python.formatting.provider": "black"
}
LICENSE 0 → 100644
+ 201
− 0
View file @ d06d6120
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
MANIFEST.in 0 → 100644
+ 7
− 0
View file @ d06d6120
include LICENSE
include README.md
include VERSION
recursive-include docs *
recursive-exclude tests *
README.md
+ 9
− 82
View file @ d06d6120
# Python Package # Example Python Package
An example repository of an CI/CD pipeline for building, testing and deploying a python package An example repository of an CI/CD pipeline for building, testing and publishing a python package
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
## Installation
``` ```
cd existing_repo pip install map
git remote add origin https://git.astron.nl/templates/python-package.git
git branch -M main
git push -uf origin main
``` ```
## Integrate with your tools
- [ ] [Set up project integrations](https://git.astron.nl/templates/python-package/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage ## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. ```
from map import cool_module
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment cool_module.greeter() # prints "Hello World"
Show your appreciation to those who have contributed to the project. ```
## License ## License
For open source projects, say how it is licensed. This project is licensed under the Apache License Version 2.0
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
VERSION 0 → 100644
+ 1
− 0
View file @ d06d6120
0.1
\ No newline at end of file
docs/.gitkeep 0 → 100644
+ 0
− 0
View file @ d06d6120
map/cool_module.py
+ 1
− 0
View file @ d06d6120
""" Cool module containing functions, classes and other useful things """ """ Cool module containing functions, classes and other useful things """
def greeter(): def greeter():
print("Hello World!") print("Hello World!")
pyproject.toml 0 → 100644
+ 3
− 0
View file @ d06d6120
[build-system]
requires = ['setuptools>=42', 'wheel']
build-backend = 'setuptools.build_meta'
requirements.txt 0 → 100644
+ 1
− 0
View file @ d06d6120
numpy
setup.cfg 0 → 100644
+ 37
− 0
View file @ d06d6120
[metadata]
name = my-awseome-app
version = file: VERSION
description = An example package for CI/CD working group
long_description = file: README.md
long_description_content_type = text/markdown
url = https://git.astron.nl/templates/python-package
license = Apache License 2.0
classifiers =
Development Status :: 3 - Alpha
Environment :: Web Environment
Intended Audience :: Developers
Intended Audience :: Science/Research
License :: OSI Approved :: Apache Software License
Operating System :: OS Independent
Programming Language :: Python
Programming Language :: Python :: 3
Programming Language :: Python :: 3 :: Only
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Topic :: Internet :: WWW/HTTP
Topic :: Internet :: WWW/HTTP :: Dynamic Content
Topic :: Scientific/Engineering
Topic :: Scientific/Engineering :: Astronomy
[options]
include_package_data = true
packages = find:
python_requires = >=3.7
install_requires =
numpy
[flake8]
max-line-length = 88
extend-ignore = E203
tests/.gitkeep 0 → 100644
+ 0
− 0
View file @ d06d6120
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment