Metadata-Version: 2.4
Name: scikit-package
Version: 0.0.3rc1
Summary: 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.
Author-email: "Simon J.L. Billinge group" <simon.billinge@gmail.com>
Maintainer-email: "Simon J.L. Billinge group" <simon.billinge@gmail.com>
Project-URL: Homepage, https://github.com/Billingegroup/scikit-package/
Project-URL: Issues, https://github.com/Billingegroup/scikit-package/issues/
Keywords: Package template,open-source software
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
License-File: AUTHORS.rst
Requires-Dist: cookiecutter
Dynamic: license-file

|Icon|
===============

.. |title| replace:: scikit-package
.. _title: https://Billingegroup.github.io/scikit-package

.. |Icon| image:: img/logos/scikit-package-logo-text.png
        :target: https://Billingegroup.github.io/scikit-package
        :height: 150px

|PyPi| |Forge| |PythonVersion| |PR|

|CI| |Codecov| |Black| |Tracking|

.. |Black| image:: https://img.shields.io/badge/code_style-black-black
        :target: https://github.com/psf/black

.. |CI| image:: https://github.com/Billingegroup/scikit-package/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
        :target: https://github.com/Billingegroup/scikit-package/actions/workflows/matrix-and-codecov-on-merge-to-main.yml

.. |Codecov| image:: https://codecov.io/gh/Billingegroup/scikit-package/branch/main/graph/badge.svg
        :target: https://codecov.io/gh/Billingegroup/scikit-package

.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/scikit-package
        :target: https://anaconda.org/conda-forge/scikit-package

.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff

.. |PyPi| image:: https://img.shields.io/pypi/v/scikit-package
        :target: https://pypi.org/project/scikit-package/

.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/scikit-package
        :target: https://pypi.org/project/scikit-package/

.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
        :target: https://github.com/Billingegroup/scikit-package/issues

``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``:

.. image:: img/figures/scikit-package-overview-qr-code.png
    :alt: Diagram of 5 levels of sharing code with key features and scikit-package commands
    :width: 800px
    :align: center


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.)

.. image:: doc/source/gif/demo.gif
        :alt: scikit-package demo
        :align: center

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 <https://billingegroup.github.io/scikit-package/>`_ as well.
