python_package_template

Template for python packages

https://github.com/hkv-products-services/python_package_template

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.7%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Template for python packages

Basic Info

Host: GitHub
Owner: HKV-products-services
License: gpl-3.0
Language: Python
Default Branch: main
Homepage: https://hkv-products-services.github.io/python_package_template/
Size: 608 KB

Statistics

Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Releases: 0

Created about 1 year ago · Last pushed 8 months ago

Metadata Files

Readme License Citation

Python package template

This template package contains core functionality for a python package, developed to showcase and speed up the process of developing a python package. This Python package template is developed by HKV and is published under the GNU GPL-3 license.

Configuring the template (remove before publishing)

Naming

The current package name is python_package_template and # Python package template, if you search for this in your IDE (e.g. VS Code) you can replace these with your given name.

Pre-commit

This repo has an example pre-commit configuration in .pre-commit-config.yaml. Depending on your needs you might want to uncomment certain sections. Let us know by making an issue if we missed a useful pre-commit. Use pre-commit install --hook-type pre-commit --hook-type pre-push to automatically run pre-commit.

GitHub Tests

In the folder .github there are four workflows which run automatically. You will need to adjust these depending on your needs.

Pixi

Read bellow for more information on pixi and a quick guideline you can include in your project.

Getting started

Using install (in future)

run pip install Python_package_template

developing with pixi

To manage the environment we use Pixi.

windows

```powershell iwr -useb https://pixi.sh/install.ps1 | iex ```

Linux/Mac

```bash curl -fsSL https://pixi.sh/install.sh | bash ```

installing

With the Pixi command in powershell install the python environment:

bash cd ../python_package_template pixi install

The pixi.lock file loads the correct packages and downloads to the .pixi file, you can use this environment in developing and resting.

For questions about how to use this package contact dupuits@hkv.nl or haasnoot@hkv.nl.

Owner

Name: HKV-products-services
Login: HKV-products-services
Kind: organization

Repositories: 4
Profile: https://github.com/HKV-products-services

Citation (CITATION.cff)

# YAML 1.2
---
authors:
  -
    affiliation: "HKV lijn in water"
    family-names: Dupuits
    given-names: Guy
  -
    affiliation: "HKV lijn in water"
    family-names: Haasnoot
    given-names: David

cff-version: "0.0.1"
keywords:
  - Waterveiligheid
license: "GPL-3.0-or-later"
message: "If you use this software, please cite it using these metadata."
title: python_package_template

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science