Initial adds
parent
d5c0dcc5d9
commit
e0f5a842c4
|
@ -86,7 +86,7 @@ Clone the repository
|
||||||
page. This creates a copy of the code under your account on |the repository service|.
|
page. This creates a copy of the code under your account on |the repository service|.
|
||||||
#. Clone this copy to your local disk::
|
#. Clone this copy to your local disk::
|
||||||
|
|
||||||
git clone git@github.com:YourLogin/hetrixtools-freebsd.git
|
git clone repository_
|
||||||
cd hetrixtools-freebsd
|
cd hetrixtools-freebsd
|
||||||
|
|
||||||
#. You should run::
|
#. You should run::
|
||||||
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
[build-system]
|
||||||
|
# AVOID CHANGING REQUIRES: IT WILL BE UPDATED BY PYSCAFFOLD!
|
||||||
|
requires = ["setuptools>=46.1.0", "setuptools_scm[toml]>=5"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[tool.setuptools_scm]
|
||||||
|
# For smarter version schemes and other configuration options,
|
||||||
|
# check out https://github.com/pypa/setuptools_scm
|
||||||
|
version_scheme = "no-guess-dev"
|
11
setup.cfg
11
setup.cfg
|
@ -68,15 +68,8 @@ testing =
|
||||||
pytest-cov
|
pytest-cov
|
||||||
|
|
||||||
[options.entry_points]
|
[options.entry_points]
|
||||||
# Add here console scripts like:
|
console_scripts =
|
||||||
# console_scripts =
|
hetrixtools = hetrixtools_freebsd.cli:run
|
||||||
# script_name = hetrixtools_freebsd.module:function
|
|
||||||
# For example:
|
|
||||||
# console_scripts =
|
|
||||||
# fibonacci = hetrixtools_freebsd.skeleton:run
|
|
||||||
# And any other entry points, for example:
|
|
||||||
# pyscaffold.cli =
|
|
||||||
# awesome = pyscaffoldext.awesome.extension:AwesomeExtension
|
|
||||||
|
|
||||||
[tool:pytest]
|
[tool:pytest]
|
||||||
# Specify command line options as you would do when invoking pytest directly.
|
# Specify command line options as you would do when invoking pytest directly.
|
||||||
|
|
|
@ -0,0 +1,21 @@
|
||||||
|
"""
|
||||||
|
Setup file for hetrixtools-freebsd.
|
||||||
|
Use setup.cfg to configure your project.
|
||||||
|
|
||||||
|
This file was generated with PyScaffold 4.5.
|
||||||
|
PyScaffold helps you to put up the scaffold of your new Python project.
|
||||||
|
Learn more under: https://pyscaffold.org/
|
||||||
|
"""
|
||||||
|
from setuptools import setup
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
try:
|
||||||
|
setup(use_scm_version={"version_scheme": "no-guess-dev"})
|
||||||
|
except: # noqa
|
||||||
|
print(
|
||||||
|
"\n\nAn error occurred while building the project, "
|
||||||
|
"please ensure you have the most updated version of setuptools, "
|
||||||
|
"setuptools_scm and wheel with:\n"
|
||||||
|
" pip install -U setuptools setuptools_scm wheel\n\n"
|
||||||
|
)
|
||||||
|
raise
|
|
@ -0,0 +1,93 @@
|
||||||
|
# Tox configuration file
|
||||||
|
# Read more under https://tox.wiki/
|
||||||
|
# THIS SCRIPT IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS!
|
||||||
|
|
||||||
|
[tox]
|
||||||
|
minversion = 3.24
|
||||||
|
envlist = default
|
||||||
|
isolated_build = True
|
||||||
|
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
description = Invoke pytest to run automated tests
|
||||||
|
setenv =
|
||||||
|
TOXINIDIR = {toxinidir}
|
||||||
|
passenv =
|
||||||
|
HOME
|
||||||
|
SETUPTOOLS_*
|
||||||
|
extras =
|
||||||
|
testing
|
||||||
|
commands =
|
||||||
|
pytest {posargs}
|
||||||
|
|
||||||
|
|
||||||
|
# # To run `tox -e lint` you need to make sure you have a
|
||||||
|
# # `.pre-commit-config.yaml` file. See https://pre-commit.com
|
||||||
|
# [testenv:lint]
|
||||||
|
# description = Perform static analysis and style checks
|
||||||
|
# skip_install = True
|
||||||
|
# deps = pre-commit
|
||||||
|
# passenv =
|
||||||
|
# HOMEPATH
|
||||||
|
# PROGRAMDATA
|
||||||
|
# SETUPTOOLS_*
|
||||||
|
# commands =
|
||||||
|
# pre-commit run --all-files {posargs:--show-diff-on-failure}
|
||||||
|
|
||||||
|
|
||||||
|
[testenv:{build,clean}]
|
||||||
|
description =
|
||||||
|
build: Build the package in isolation according to PEP517, see https://github.com/pypa/build
|
||||||
|
clean: Remove old distribution files and temporary build artifacts (./build and ./dist)
|
||||||
|
# https://setuptools.pypa.io/en/stable/build_meta.html#how-to-use-it
|
||||||
|
skip_install = True
|
||||||
|
changedir = {toxinidir}
|
||||||
|
deps =
|
||||||
|
build: build[virtualenv]
|
||||||
|
passenv =
|
||||||
|
SETUPTOOLS_*
|
||||||
|
commands =
|
||||||
|
clean: python -c 'import shutil; [shutil.rmtree(p, True) for p in ("build", "dist", "docs/_build")]'
|
||||||
|
clean: python -c 'import pathlib, shutil; [shutil.rmtree(p, True) for p in pathlib.Path("src").glob("*.egg-info")]'
|
||||||
|
build: python -m build {posargs}
|
||||||
|
# By default, both `sdist` and `wheel` are built. If your sdist is too big or you don't want
|
||||||
|
# to make it available, consider running: `tox -e build -- --wheel`
|
||||||
|
|
||||||
|
|
||||||
|
[testenv:{docs,doctests,linkcheck}]
|
||||||
|
description =
|
||||||
|
docs: Invoke sphinx-build to build the docs
|
||||||
|
doctests: Invoke sphinx-build to run doctests
|
||||||
|
linkcheck: Check for broken links in the documentation
|
||||||
|
passenv =
|
||||||
|
SETUPTOOLS_*
|
||||||
|
setenv =
|
||||||
|
DOCSDIR = {toxinidir}/docs
|
||||||
|
BUILDDIR = {toxinidir}/docs/_build
|
||||||
|
docs: BUILD = html
|
||||||
|
doctests: BUILD = doctest
|
||||||
|
linkcheck: BUILD = linkcheck
|
||||||
|
deps =
|
||||||
|
-r {toxinidir}/docs/requirements.txt
|
||||||
|
# ^ requirements.txt shared with Read The Docs
|
||||||
|
commands =
|
||||||
|
sphinx-build --color -b {env:BUILD} -d "{env:BUILDDIR}/doctrees" "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" {posargs}
|
||||||
|
|
||||||
|
|
||||||
|
[testenv:publish]
|
||||||
|
description =
|
||||||
|
Publish the package you have been developing to a package index server.
|
||||||
|
By default, it uses testpypi. If you really want to publish your package
|
||||||
|
to be publicly accessible in PyPI, use the `-- --repository pypi` option.
|
||||||
|
skip_install = True
|
||||||
|
changedir = {toxinidir}
|
||||||
|
passenv =
|
||||||
|
# See: https://twine.readthedocs.io/en/latest/
|
||||||
|
TWINE_USERNAME
|
||||||
|
TWINE_PASSWORD
|
||||||
|
TWINE_REPOSITORY
|
||||||
|
TWINE_REPOSITORY_URL
|
||||||
|
deps = twine
|
||||||
|
commands =
|
||||||
|
python -m twine check dist/*
|
||||||
|
python -m twine upload {posargs:--repository {env:TWINE_REPOSITORY:testpypi}} dist/*
|
Loading…
Reference in New Issue