diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json deleted file mode 100644 index f5b718c..0000000 --- a/.devcontainer/devcontainer.json +++ /dev/null @@ -1,14 +0,0 @@ -// For format details, see https://aka.ms/devcontainer.json. For config options, see the -{ - "image":"ghcr.io/uw-ssec/tutorial-scipy-2024:latest", - - "customizations": { - "vscode": { - "extensions": [ - "ms-toolsai.jupyter", - "ms-python.python" - ] - } - }, - "postCreateCommand": "sh .devcontainer/postBuild.sh" -} diff --git a/.devcontainer/postBuild.sh b/.devcontainer/postBuild.sh deleted file mode 100644 index e69de29..0000000 diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..4556ff4 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +version: 2 +updates: + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + groups: + actions: + patterns: + - "*" \ No newline at end of file diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..ae09d8e --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,5 @@ +changelog: + exclude: + authors: + - dependabot + - pre-commit-ci \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 5df36e2..0000000 --- a/.gitignore +++ /dev/null @@ -1,163 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# poetry -# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. -# This is especially recommended for binary packages to ensure reproducibility, and is more -# commonly ignored for libraries. -# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control -#poetry.lock - -# pdm -# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. -#pdm.lock -# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it -# in version control. -# https://pdm.fming.dev/#use-with-ide -.pdm.toml - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - -# PyCharm -# JetBrains specific template is maintained in a separate JetBrains.gitignore that can -# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore -# and can be added to the global gitignore or merged into this file. For a more nuclear -# option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ - -# MacOS -.DS_Store diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ffc5322 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,43 @@ +ci: + autoupdate_commit_msg: "chore: update pre-commit hooks" + autofix_commit_msg: "style: pre-commit fixes" + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: "v4.6.0" + hooks: + - id: check-added-large-files + - id: check-case-conflict + - id: check-merge-conflict + - id: check-symlinks + - id: check-yaml + - id: debug-statements + - id: end-of-file-fixer + - id: mixed-line-ending + - id: trailing-whitespace + + - repo: https://github.com/pre-commit/mirrors-prettier + rev: "v3.1.0" + hooks: + - id: prettier + types_or: [yaml, markdown, html, css, scss, javascript, json] + args: [--prose-wrap=always] + + - repo: https://github.com/codespell-project/codespell + rev: "v2.3.0" + hooks: + - id: codespell + + - repo: local + hooks: + - id: disallow-caps + name: Disallow improper capitalization + language: pygrep + entry: Github + exclude: .pre-commit-config.yaml + + - repo: https://github.com/python-jsonschema/check-jsonschema + rev: "0.28.4" + hooks: + - id: check-dependabot + - id: check-github-workflows diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index a74cef1..20f0a98 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -5,9 +5,9 @@ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. +identity and expression, level of experience, education, socioeconomic status, +nationality, personal appearance, race, religion, or sexual identity and +orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community +- Focusing on what is best not just for us as individuals, but for the overall + community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -59,37 +59,38 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the maintainers responsible for enforcement anonymously in a form [here](https://form.jotform.us/70666109215151). -All complaints will be reviewed and investigated promptly and fairly. +reported to the maintainers responsible for enforcement anonymously in a form +[here](https://form.jotform.us/70666109215151). All complaints will be reviewed +and investigated promptly and fairly. All maintainers are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines -Maintainers will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: +Maintainers will follow these Community Impact Guidelines in determining the +consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. -**Consequence**: A private, written warning from maintainers, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. +**Consequence**: A private, written warning from maintainers, providing clarity +around the nature of the violation and an explanation of why the behavior was +inappropriate. A public apology may be requested. ### 2. Warning -**Community Impact**: A violation through a single incident or series -of actions. +**Community Impact**: A violation through a single incident or series of +actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. +like social media. Violating these terms may lead to a temporary or permanent +ban. ### 3. Temporary Ban @@ -105,11 +106,11 @@ Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an +standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. -**Consequence**: A permanent ban from any sort of public interaction within -the community. +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution @@ -117,8 +118,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org diff --git a/LICENSE b/LICENSE index 2dd37d1..4acf8b0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,28 +1,12 @@ BSD 3-Clause License -Copyright (c) 2024, UW Scientific Software Engineering Center +Copyright (c) 2024 University of Washington, eScience Institute, Scientific Software Engineering Center +All rights reserved. -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +3. Neither the name of the University of Washington nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file +THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY OF WASHINGTON AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF WASHINGTON OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index bf24a7e..a9f77fe 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,7 @@ # project-template -Project repository template for SSEC projects + +Blank project repository template for General SSEC projects. + +This includes some default +[community health files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types) +such as as a code of conduct and license file. diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 298ea9e..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,19 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index c9cb7bf..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -ipywidgets -jupyter-book -matplotlib -pyro-ppl -sphinx -sphinx_rtd_theme \ No newline at end of file diff --git a/docs/source/_toc.yml b/docs/source/_toc.yml deleted file mode 100644 index bdf670c..0000000 --- a/docs/source/_toc.yml +++ /dev/null @@ -1,11 +0,0 @@ -# Table of contents -# Learn more at https://jupyterbook.org/customize/toc.html - -format: jb-book -root: intro -chapters: - - file: getting_started - - file: install - - file: contributing - - file: license - - file: genindex \ No newline at end of file diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst deleted file mode 100644 index ca32f93..0000000 --- a/docs/source/contributing.rst +++ /dev/null @@ -1,130 +0,0 @@ -See the `Scientific Python Developer Guide `_ for a detailed -description of best practices for developing scientific packages. - -Quick development ------------------ - -The fastest way to start with development is to use ``nox``. This will set up a -virtual environment for you to run all the checks and tests. There are 2 ways to -install ``nox``: - -Codespaces -~~~~~~~~~~ - -Nox is pre-installed in the Codespaces environment. So, after activating a -Codespace, you can just open the terminal and run ``nox`` to run all the checks -and tests. - -Local -~~~~~ - -If you don't have nox, you can do the following to install ``nox``: - -.. code-block:: bash - - pip install nox - -If you use macOS, then ``nox`` is in brew: - -.. code-block:: bash - - brew install nox - -Nox basics -~~~~~~~~~~ - -What is it? -^^^^^^^^^^^ - -``nox`` is a command-line tool that automates testing in multiple Python -environments, similar to tox. Unlike tox, Nox uses a standard Python file for -configuration, you can find this configuration in ``noxfile.py``. - -How do I use it? -^^^^^^^^^^^^^^^^ - -To use, run ``nox``. This will lint and test using every installed version of -Python on your system, skipping ones that are not installed. You can also run -specific jobs: - -.. code-block:: bash - - nox -s lint # Lint only - nox -s tests # Python tests - nox -s build # Make an SDist and wheel - -Nox handles everything for you, including setting up a temporary virtual -environment for each run. - -Setting up a development environment manually ---------------------------------------------- - -You can set up a development environment by running: - -.. code-block:: bash - - python3 -m venv .venv - source ./.venv/bin/activate - pip install -v -e .[dev] - -If you have the -`Python Launcher for Unix `_, you -can instead do: - -.. code-block:: bash - - py -m venv .venv - py -m install -v -e .[dev] - -Post setup ----------- - -You should prepare pre-commit, which will help you by checking that commits pass -required checks: - -.. code-block:: bash - - pip install pre-commit # or brew install pre-commit on macOS - pre-commit install # Will install a pre-commit hook into the git repo - -You can also/alternatively run ``pre-commit run`` (changes only) or -``pre-commit run --all-files`` to check even without installing the hook. - -Testing -------- - -Use pytest to run the unit checks: - -.. code-block:: bash - - pytest - -Coverage --------- - -Use pytest-cov to generate coverage reports: - -.. code-block:: bash - - pytest --cov=python_template - -Pre-commit ----------- - -This project uses pre-commit for all style checking. While you can run it with -nox, this is such an important tool that it deserves to be installed on its own. -Install pre-commit and run: - -.. code-block:: bash - - pre-commit run -a - -to check all files. - -Code of Conduct ---------------- - -By contributing to this project, you agree to abide by the `Code of Conduct -`_. -Please make sure to read and understand the guidelines outlined in the Code -of Conduct before making any contributions. \ No newline at end of file diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst deleted file mode 100644 index ca35bc4..0000000 --- a/docs/source/getting_started.rst +++ /dev/null @@ -1,14 +0,0 @@ - -Getting Started -=============== - -Install -------- - -Please follow the instructions on the :doc:`install` page. For most users, the basic pip install is all that's needed. - - -Read The Docs -------------- - -Docs for all the main functions in vectordb are available at :doc:`vectordb` at varying degrees of completeness. Further development of the docs is always ongoing. \ No newline at end of file diff --git a/docs/source/install.rst b/docs/source/install.rst deleted file mode 100644 index 3cff74d..0000000 --- a/docs/source/install.rst +++ /dev/null @@ -1,30 +0,0 @@ - -Installation -============ - -Regular Install ---------------- - -The easiest way to install is to make a new virtual environment then run:: - - pip install python-template - -this will install all the required libraries and then install python-template and you are ready to go! You can check out the tutorials afterwards to see some of python-template's capabilities. - - -Developer Install ------------------ - -First clone the repo with:: - - git clone git@github.com:uw-ssec/python-template.git - -this will create a directory ``python-template`` wherever you ran the command. Next go into the directory and install in developer mode:: - - pip install -e ".[dev]" - -this will install all relevant libraries and then install python-template in an editable format so any changes you make to the code will be included next time you import the package. To start making changes you should immediately create a new branch:: - - git checkout -b - -you can edit this branch however you like. If you are happy with the results and want to share with the rest of the community, then follow the contributors guide to create a pull request! \ No newline at end of file diff --git a/docs/source/license.rst b/docs/source/license.rst deleted file mode 100644 index 3656150..0000000 --- a/docs/source/license.rst +++ /dev/null @@ -1,15 +0,0 @@ -License -======= - -BSD 3-Clause License - -Copyright (c) 2024 University of Washington, eScience Institute, Scientific Software Engineering Center -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -3. Neither the name of the University of Washington nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY OF WASHINGTON AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF WASHINGTON OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/noxfile.py b/noxfile.py deleted file mode 100644 index 31c5a9b..0000000 --- a/noxfile.py +++ /dev/null @@ -1,53 +0,0 @@ -from __future__ import annotations - -import shutil -from pathlib import Path - -import nox - -DIR = Path(__file__).parent.resolve() - -nox.options.sessions = ["lint", "pylint", "tests", "build"] - - -@nox.session -def lint(session: nox.Session) -> None: - """ - Run the linter. - """ - session.install("pre-commit") - session.run("pre-commit", "run", "--all-files", *session.posargs) - - -@nox.session -def pylint(session: nox.Session) -> None: - """ - Run PyLint. - """ - # This needs to be installed into the package environment, and is slower - # than a pre-commit check - session.install(".", "pylint") - session.run("pylint", "src", *session.posargs) - - -@nox.session -def tests(session: nox.Session) -> None: - """ - Run the unit and regular tests. Use --cov to activate coverage. - """ - session.install(".[dev]") - session.run("pytest", *session.posargs) - - -@nox.session -def build(session: nox.Session) -> None: - """ - Build an SDist and wheel. - """ - - build_p = DIR.joinpath("build") - if build_p.exists(): - shutil.rmtree(build_p) - - session.install("build") - session.run("python", "-m", "build") \ No newline at end of file diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index e69de29..0000000 diff --git a/src/project-name/__init__.py b/src/project-name/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/src/project-name/_version.py b/src/project-name/_version.py deleted file mode 100644 index eb9bc82..0000000 --- a/src/project-name/_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# file generated by setuptools_scm -# don't change, don't track in version control -TYPE_CHECKING = False -if TYPE_CHECKING: - from typing import Tuple, Union - VERSION_TUPLE = Tuple[Union[int, str], ...] -else: - VERSION_TUPLE = object - -version: str -__version__: str -__version_tuple__: VERSION_TUPLE -version_tuple: VERSION_TUPLE - -__version__ = version = '0.1.dev132' -__version_tuple__ = version_tuple = (0, 1, 'dev132') \ No newline at end of file diff --git a/tests/__init__.py b/tests/__init__.py deleted file mode 100644 index e69de29..0000000