Skip to content

Commit e976ff4

Browse files
tobiasraabetobiasraabe
authored
Prepare pytask-environment to be published on PyPI. (#3)
1 parent 41eeb2c commit e976ff4

22 files changed

+2637
-26
lines changed

‎.conda/bld.bat

-2
This file was deleted.

‎.conda/build.sh

-1
This file was deleted.

‎.conda/meta.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ source:
1212
build:
1313
noarch: python
1414
number: 0
15+
script: {{ PYTHON }} setup.py install --single-version-externally-managed --record record.txt
1516

1617
requirements:
1718
host:
1819
- python
20+
- pip
1921
- setuptools
2022

2123
run:
@@ -38,6 +40,7 @@ test:
3840

3941
about:
4042
home: https://github.com/pytask-dev/pytask-environment
41-
license: none
43+
license: MIT
44+
license_file: LICENSE
4245
summary: Ensure checks on the current Python environment.
4346
dev_url: https://github.com/pytask-dev/pytask-environment/

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
src/pytask_environment/_version.py export-subst

‎.github/ISSUE_TEMPLATE/bug_report.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22

33
name: Bug Report
4-
about: Create a bug report to help us improve pytask-latex
4+
about: Create a bug report to help us improve pytask-environment
55
title: "BUG:"
66
labels: "bug"
77

88
---
99

1010
- [ ] I have checked that this issue has not already been reported.
1111

12-
- [ ] I have confirmed this bug exists on the latest version of pytask-latex.
12+
- [ ] I have confirmed this bug exists on the latest version of pytask-environment.
1313

1414
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15-
pytask-latex.
15+
pytask-environment.
1616

1717
---
1818

‎.github/ISSUE_TEMPLATE/documentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ labels: "documentation"
1212
Provide the location of the documentation, e.g. an URL of the documentation.
1313

1414
**Note**: You can check the latest versions of the docs on `main`
15-
[here](https://pytask-latex.readthedocs.io/en/latest).
15+
[here](https://pytask-environment.readthedocs.io/en/latest).
1616

1717
#### Documentation problem
1818

‎.github/ISSUE_TEMPLATE/enhancement.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22

33
name: Enhancement
4-
about: Suggest an idea for pytask-latex
4+
about: Suggest an idea for pytask-environment
55
title: "ENH:"
66
labels: "enhancement"
77

88
---
99

1010
#### Is your feature request related to a problem?
1111

12-
Provide a description of what the problem is, e.g. "I wish I could use pytask-latex
12+
Provide a description of what the problem is, e.g. "I wish I could use pytask-environment
1313
to do [...]".
1414

1515
#### Describe the solution you'd like

‎.github/ISSUE_TEMPLATE/question.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22

33
name: Submit Question
4-
about: Ask a general question about pytask-latex
4+
about: Ask a general question about pytask-environment
55
title: "QST:"
66
labels: "question"
77

88
---
99

10-
#### Question about pytask-latex
10+
#### Question about pytask-environment
1111

1212
**Note**: If you'd still like to submit a question, please read [this guide](
1313
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to

‎.github/workflows/publish-to-pypi.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: PyPI
2+
3+
on: push
4+
5+
jobs:
6+
build-n-publish:
7+
name: Build and publish Python 🐍 distributions 📦 to PyPI
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@master
11+
12+
- name: Set up Python 3.8
13+
uses: actions/setup-python@v1
14+
with:
15+
python-version: 3.8
16+
17+
- name: Install pypa/build
18+
run: >-
19+
python -m
20+
pip install
21+
build
22+
--user
23+
24+
- name: Build a binary wheel and a source tarball
25+
run: >-
26+
python -m
27+
build
28+
--sdist
29+
--wheel
30+
--outdir dist/
31+
32+
- name: Publish distribution 📦 to PyPI
33+
if: startsWith(github.ref, 'refs/tags')
34+
uses: pypa/gh-action-pypi-publish@master
35+
with:
36+
password: ${{ secrets.PYPI_API_TOKEN }}

‎.pre-commit-config.yaml

+6-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,12 @@ repos:
7171
- repo: https://github.com/codespell-project/codespell
7272
rev: v2.0.0
7373
hooks:
74-
- id: codespell
75-
args: [-L=als]
74+
- id: codespell
75+
args: [-L als, -L unparseable]
76+
- repo: https://github.com/mgedmin/check-manifest
77+
rev: "0.46"
78+
hooks:
79+
- id: check-manifest
7680
- repo: meta
7781
hooks:
7882
- id: check-hooks-apply

‎CHANGES.rst

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ all releases are available on `Anaconda.org
77
<https://anaconda.org/pytask/pytask-environment>`_.
88

99

10+
0.0.2 - 2021-02-27
11+
------------------
12+
13+
- :gh:`3` prepares pytask-environment to be published on PyPI, adds versioneer, and
14+
more.
15+
16+
1017
0.0.1 - 2020-10-04
1118
------------------
1219

‎LICENSE

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Copyright 2020-2021 Tobias Raabe
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this
4+
software and associated documentation files (the "Software"), to deal in the Software
5+
without restriction, including without limitation the rights to use, copy, modify,
6+
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
7+
permit persons to whom the Software is furnished to do so, subject to the following
8+
conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all copies or
11+
substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
14+
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
15+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
17+
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
18+
OTHER DEALINGS IN THE SOFTWARE.

‎MANIFEST.in

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include LICENSE
2+
include versioneer.py
3+
include src/pytask_environment/_version.py
4+
5+
exclude *.rst
6+
exclude *.yml
7+
exclude *.yaml
8+
exclude tox.ini
9+
10+
prune .conda
11+
prune tests

‎README.rst

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
.. image:: https://img.shields.io/pypi/v/pytask-environment?color=blue
2+
:alt: PyPI
3+
:target: https://pypi.org/project/pytask-environment
4+
5+
.. image:: https://img.shields.io/pypi/pyversions/pytask-environment
6+
:alt: PyPI - Python Version
7+
:target: https://pypi.org/project/pytask-environment
8+
19
.. image:: https://anaconda.org/pytask/pytask-environment/badges/version.svg
210
:target: https://anaconda.org/pytask/pytask-environment
311

@@ -7,9 +15,16 @@
715
.. image:: https://github.com/pytask-dev/pytask-environment/workflows/Continuous%20Integration%20Workflow/badge.svg?branch=main
816
:target: https://github.com/pytask-dev/pytask/actions?query=branch%3Amain
917

18+
.. image:: https://img.shields.io/pypi/l/pytask-environment
19+
:alt: PyPI - License
20+
1021
.. image:: https://codecov.io/gh/pytask-dev/pytask-environment/branch/main/graph/badge.svg
1122
:target: https://codecov.io/gh/pytask-dev/pytask-environment
1223

24+
.. image:: https://results.pre-commit.ci/badge/github/pytask-dev/pytask-environment/main.svg
25+
:target: https://results.pre-commit.ci/latest/github/pytask-dev/pytask-environment/main
26+
:alt: pre-commit.ci status
27+
1328
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
1429
:target: https://github.com/psf/black
1530

@@ -25,10 +40,15 @@ project build.
2540
Installation
2641
------------
2742

28-
Install the plugin with
43+
pytask-environment is available on `PyPI <https://pypi.org/project/pytask-environment>`_
44+
and `Anaconda.org <https://anaconda.org/pytask/pytask-environment>`_. Install it with
2945

3046
.. code-block:: console
3147
48+
$ pip install pytask-environment
49+
50+
# or
51+
3252
$ conda config --add channels conda-forge --add channels pytask
3353
$ conda install pytask-environment
3454

‎codecov.yml

+2
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,5 @@ coverage:
2222
ignore:
2323
- ".tox/**/*"
2424
- "setup.py"
25+
- "versioneer.py"
26+
- "src/pytask_environment/_version.py"

‎environment.yml

+1
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ dependencies:
2121
- pre-commit
2222
- pytest-cov
2323
- pytest-xdist
24+
- versioneer

‎setup.cfg

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
[bumpversion]
2-
current_version = 0.0.4
3-
parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))(\-?((dev)?(?P<dev>\d+))?)
4-
serialize =
5-
{major}.{minor}.{patch}dev{dev}
6-
{major}.{minor}.{patch}
7-
8-
[bumpversion:file:setup.py]
9-
10-
[bumpversion:file:src/pytask_latex/__init__.py]
1+
[versioneer]
2+
VCS = git
3+
style = pep440
4+
versionfile_source = src/pytask_environment/_version.py
5+
versionfile_build = pytask_environment/_version.py
6+
tag_prefix = v
7+
parentdir_prefix = pytask-environment-

‎setup.py

+38-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,47 @@
1+
from pathlib import Path
2+
13
from setuptools import find_packages
24
from setuptools import setup
35

6+
import versioneer
7+
8+
README = Path("README.rst").read_text()
9+
10+
PROJECT_URLS = {
11+
"Documentation": "https://github.com/pytask-dev/pytask-environment",
12+
"Github": "https://github.com/pytask-dev/pytask-environment",
13+
"Tracker": "https://github.com/pytask-dev/pytask-environment/issues",
14+
"Changelog": "https://github.com/pytask-dev/pytask-environment/blob/main/"
15+
"CHANGES.rst",
16+
}
17+
18+
419
setup(
520
name="pytask-environment",
6-
version="0.0.1",
21+
version=versioneer.get_version(),
22+
cmd_class=versioneer.get_cmdclass(),
23+
description="Detect changes in your pytask environment and abort a project build.",
24+
long_description=README,
25+
long_description_content_type="text/x-rst",
26+
author="Tobias Raabe",
27+
author_email="[email protected]",
28+
python_requires=">=3.6",
29+
url=PROJECT_URLS["Github"],
30+
project_urls=PROJECT_URLS,
31+
license="MIT",
32+
classifiers=[
33+
"Development Status :: 3 - Alpha",
34+
"Operating System :: OS Independent",
35+
"Programming Language :: Python :: 3",
36+
"Programming Language :: Python :: 3 :: Only",
37+
"Programming Language :: Python :: 3.6",
38+
"Programming Language :: Python :: 3.7",
39+
"Programming Language :: Python :: 3.8",
40+
"Programming Language :: Python :: 3.9",
41+
],
42+
platforms="any",
743
packages=find_packages(where="src"),
844
package_dir={"": "src"},
945
entry_points={"pytask": ["pytask_environment = pytask_environment.plugin"]},
46+
zip_false=False,
1047
)

‎src/pytask_environment/__init__.py

+5
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11
__version__ = "0.0.1"
2+
3+
from ._version import get_versions
4+
5+
__version__ = get_versions()["version"]
6+
del get_versions

0 commit comments

Comments
 (0)