Skip to main content

A Python package standard and generator for scientific code. Use scikit-package to launch a new project or migrate existing ones to support the latest Python versions and streamline the process of distributing and maintaining your software package.

Project description

PyPi Forge PythonVersion PR

CI Codecov Black Tracking

scikit-package offers tools and practices for the scientific community to make better and more reusable Scientific Python packages and applications:

  • We help scientists share scientific code to amplify research impact.

  • We help scientists save time, allowing them to focus on writing scientific code.

  • We offer best practices from the group’s experience in developing scientific software.

Overview

Here is an overview of the 5 levels of sharing code and the key features of scikit-package:

Diagram of 5 levels of sharing code with key features and scikit-package commands

Demo

Here is how you can use scikit-package to create a lightweight Python package (Level 4):

(FIXME: Replace this GIF with a Level 4 demo with updated file/folder names.)

scikit-package demo

Getting started

Are you interested in using scikit-package? Begin with the Getting Started page in our online documentation at https://Billingegroup.github.io/scikit-package!

How to cite scikit-package

If you use scikit-package to standardize your Python software, we would like you to cite scikit-package as follows:

scikit-package, https://github.com/Billingegroup/scikit-package

Acknowledgements

This GitHub repository is built and maintained with the help of scikit-package as well.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scikit_package-0.0.3rc1.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scikit_package-0.0.3rc1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file scikit_package-0.0.3rc1.tar.gz.

File metadata

  • Download URL: scikit_package-0.0.3rc1.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for scikit_package-0.0.3rc1.tar.gz
Algorithm Hash digest
SHA256 34a778430f6e663e9de6c03a23d62ae0fb0de6720c5b32d026230539b7f1cc6b
MD5 3c1b2eabd4eb586127a64acd73c0cf6d
BLAKE2b-256 e2931e458cb98665843cc821d8cd3614e073f7dcd6b30ecfc708c32b7a7f6fff

See more details on using hashes here.

File details

Details for the file scikit_package-0.0.3rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for scikit_package-0.0.3rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 2d0919330b33053ea64fed71fd7f11e8d5cac504e49f767c1e0d34fc111d6c8b
MD5 830124f2e341197afd956300f9d22d7b
BLAKE2b-256 d29e482dc2fac5ba564898a0d379a54968ec4dda1263f793d317a09558e272fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page