Skip to content

Commit 2492bcf

Browse files
committed
Updated files with 'repo_helper'.
1 parent d959de8 commit 2492bcf

File tree

11 files changed

+128
-96
lines changed

11 files changed

+128
-96
lines changed

.github/workflows/python_ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# This file is managed by `repo_helper`. Don't edit it directly
12
---
23
name: Windows Tests
34

.github/workflows/python_ci_macos.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# This file is managed by `repo_helper`. Don't edit it directly
12
---
23
name: macOS Tests
34

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ install:
1515

1616
- pip install pip --upgrade
1717
- pip install tox tox-travis
18-
- pip install coveralls
18+
- pip install coveralls coverage_pyver_pragma
1919

2020
script:
2121
- tox
@@ -27,7 +27,7 @@ stages:
2727
- test
2828
- deploy_pypi
2929
- deploy_conda
30-
- deploy_releases
30+
3131

3232
jobs:
3333
include:

__pkginfo__.py

Lines changed: 12 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
"__version__",
2020
"modname",
2121
"pypi_name",
22-
"py_modules",
23-
"entry_points",
2422
"__license__",
2523
"__author__",
2624
"short_desc",
@@ -29,13 +27,11 @@
2927
"github_username",
3028
"web",
3129
"github_url",
32-
"project_urls",
3330
"repo_root",
34-
"long_description",
3531
"install_requires",
3632
"extras_require",
37-
"classifiers",
38-
"keywords",
33+
"project_urls",
34+
3935
"import_name",
4036
]
4137

@@ -44,58 +40,30 @@
4440
"""
4541

4642
__version__ = "0.3.8"
47-
4843
modname = "domdf_python_tools"
4944
pypi_name = "domdf_python_tools"
5045
import_name = "domdf_python_tools"
51-
py_modules = []
52-
entry_points = {
53-
"console_scripts": [],
54-
}
55-
5646
__license__ = "GNU Lesser General Public License v3 or later (LGPLv3+)"
57-
5847
short_desc = "Helpful functions for Python 🐍 🛠️"
59-
6048
__author__ = author = "Dominic Davis-Foster"
6149
author_email = "[email protected]"
6250
github_username = "domdfcoding"
63-
web = github_url = f"https://github.com/domdfcoding/domdf_python_tools"
64-
project_urls = {
65-
"Documentation": f"https://domdf_python_tools.readthedocs.io",
66-
"Issue Tracker": f"{github_url}/issues",
67-
"Source Code": github_url,
68-
}
69-
51+
web = github_url = "https://github.com/domdfcoding/domdf_python_tools"
7052
repo_root = pathlib.Path(__file__).parent
53+
install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
54+
extras_require = {'dates': ['pytz>=2019.1'], 'all': ['pytz>=2019.1']}
55+
56+
7157

72-
# Get info from files; set: long_description
73-
long_description = (repo_root / "README.rst").read_text(encoding="utf-8").replace("0.3.8", __version__) + '\n'
7458
conda_description = """Helpful functions for Python 🐍 🛠️
7559
7660
7761
Before installing please ensure you have added the following channels: domdfcoding, conda-forge"""
7862
__all__.append("conda_description")
7963

80-
install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
81-
extras_require = {'dates': ['pytz>=2019.1'], 'all': ['pytz>=2019.1']}
82-
83-
classifiers = [
84-
'Development Status :: 4 - Beta',
85-
'Intended Audience :: Developers',
86-
'License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)',
87-
'Operating System :: OS Independent',
88-
'Programming Language :: Python',
89-
'Programming Language :: Python :: 3 :: Only',
90-
'Programming Language :: Python :: 3.6',
91-
'Programming Language :: Python :: 3.7',
92-
'Programming Language :: Python :: 3.8',
93-
'Programming Language :: Python :: 3.9',
94-
'Programming Language :: Python :: Implementation :: CPython',
95-
'Programming Language :: Python :: Implementation :: PyPy',
96-
'Topic :: Software Development :: Libraries :: Python Modules',
97-
'Typing :: Typed',
9864

99-
]
100-
101-
keywords = "utilities"
65+
project_urls = {
66+
"Documentation": "https://domdf_python_tools.readthedocs.io",
67+
"Issue Tracker": f"{github_url}/issues",
68+
"Source Code": github_url,
69+
}

doc-source/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# User-configurable lines
1919
# End of user-configurable lines
2020

21-
github_url = f"https://github.com/domdfcoding/domdf_python_tools"
21+
github_url = "https://github.com/domdfcoding/domdf_python_tools"
2222

2323
rst_prolog = f""".. |pkgname| replace:: domdf_python_tools
2424
.. |pkgname2| replace:: ``domdf_python_tools``
@@ -48,6 +48,7 @@
4848
"sphinx_autodoc_typehints",
4949
"sphinx.ext.autosummary",
5050
"autodocsumm",
51+
"sphinx_copybutton",
5152
]
5253

5354
sphinxemoji_style = 'twemoji'
@@ -81,15 +82,14 @@
8182
'logo_only': False,
8283
}
8384
html_theme_path = ["../.."]
84-
# html_logo = "logo/pyms.png"
85-
html_show_sourcelink = False # True will show link to source
85+
html_show_sourcelink = True # True will show link to source
8686

8787
html_context = {
8888
'display_github': True,
8989
'github_user': 'domdfcoding',
9090
'github_repo': 'domdf_python_tools',
9191
'github_version': 'master',
92-
'conf_py_path': '/',
92+
'conf_py_path': '/doc-source/',
9393
}
9494

9595
htmlhelp_basename = slug

doc-source/docutils.conf

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[restructuredtext parser]
2+
tab_width: 4

doc-source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ autodocsumm
22
extras_require
33
pytz >=2019.1
44
sphinx >=3.0.3
5+
sphinx-copybutton >=0.2.12
56
sphinx-notfound-page
67
sphinx-prompt >=1.2.0
78
sphinx-tabs >=1.1.13

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[build-system]
2+
requires = [
3+
"setuptools >= 40.6.0",
4+
"wheel >= 0.34.2",
5+
6+
]
7+
build-backend = "setuptools.build_meta"

setup.cfg

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[metadata]
2+
name = domdf_python_tools
3+
description = Helpful functions for Python 🐍 🛠️
4+
author = Dominic Davis-Foster
5+
author_email = [email protected]
6+
license = GNU Lesser General Public License v3 or later (LGPLv3+)
7+
keywords =
8+
utilities
9+
long_description = file: README.rst
10+
long_description_content_type = text/x-rst
11+
platforms =
12+
Windows
13+
macOS
14+
Linux
15+
url = https://github.com/domdfcoding/domdf_python_tools
16+
project_urls =
17+
Documentation = https://domdf_python_tools.readthedocs.io
18+
Issue_Tracker = https://github.com/domdfcoding/domdf_python_tools/issues
19+
Source_Code = https://github.com/domdfcoding/domdf_python_tools
20+
classifiers =
21+
Development Status :: 4 - Beta
22+
Intended Audience :: Developers
23+
License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
24+
Operating System :: OS Independent
25+
Programming Language :: Python
26+
Programming Language :: Python :: 3 :: Only
27+
Programming Language :: Python :: 3.6
28+
Programming Language :: Python :: 3.7
29+
Programming Language :: Python :: 3.8
30+
Programming Language :: Python :: 3.9
31+
Programming Language :: Python :: Implementation :: CPython
32+
Programming Language :: Python :: Implementation :: PyPy
33+
Topic :: Software Development :: Libraries :: Python Modules
34+
Typing :: Typed
35+
36+
37+
38+
[options]
39+
python_requires = >=3.6
40+
zip_safe = False
41+
include_package_data = True
42+
packages = find:
43+
44+
45+
[options.packages.find]
46+
exclude =
47+
tests
48+
tests.*
49+
doc-source

setup.py

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,23 @@
22
# This file is managed by `repo_helper`. Don't edit it directly
33
"""Setup script"""
44

5+
# stdlib
6+
import sys
7+
58
# 3rd party
6-
from setuptools import find_packages, setup
9+
from setuptools import setup
10+
11+
sys.path.append(".")
712

813
# this package
914
from __pkginfo__ import * # pylint: disable=wildcard-import
1015

1116

1217

1318
setup(
14-
author=author,
15-
author_email=author_email,
16-
classifiers=classifiers,
17-
description=short_desc,
18-
entry_points=entry_points,
1919
extras_require=extras_require,
20-
include_package_data=True,
2120
install_requires=install_requires,
22-
keywords=keywords,
23-
license=__license__,
24-
long_description=long_description,
25-
name=pypi_name,
26-
packages=find_packages(exclude=("tests", "doc-source")),
27-
project_urls=project_urls,
28-
py_modules=py_modules,
29-
python_requires=">=3.6",
30-
url=web,
21+
py_modules=[],
3122
version=__version__,
32-
zip_safe=False,
3323

3424
)

0 commit comments

Comments
 (0)