Skip to content

Commit 5cf1e06

Browse files
committed
chore: ignore test dir in build
1 parent bd5c1dd commit 5cf1e06

4 files changed

Lines changed: 55 additions & 40 deletions

File tree

.gitignore

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
.env
2-
.DS_Store
31
__pycache__
4-
build
5-
dist
2+
.coverage
3+
.DS_Store
4+
.env
65
*.egg-info
7-
venv
6+
dist
87
htmlcov
9-
.coverage
8+
venv

CHANGELOG.md

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,69 @@
11
# CHANGELOG
22

3+
## v1.8.0 (2022-05-15)
4+
5+
- Overhaul the build process (uses the `build` package instead of the legacy `python setup.py` command)
6+
- Simplifies the GitHub release workflow by using the new Makefile build targets
7+
- Ignores the test directory in the build
8+
- Pins all development dependencies
9+
310
## v1.7.1 (2022-02-10)
411

5-
* Update Makefile install target to not symlink to the home directory
6-
* Update Black to use the `preview` flag
7-
* Bump dev dependencies
12+
- Update Makefile install target to not symlink to the home directory
13+
- Update Black to use the `preview` flag
14+
- Bump dev dependencies
815

916
## v1.7.0 (2021-11-29)
1017

11-
* Adds `mypy` and type hinting via `py.typed`
12-
* Simplifies template module (removes unused class)
13-
* Adds missing `__all__` variable to `__init__.py`
14-
* Simplifies the lint step of the build by only running checks once (previously some checks were getting run twice)
15-
* Tests against Python `3.10`
18+
- Adds `mypy` and type hinting via `py.typed`
19+
- Simplifies template module (removes unused class)
20+
- Adds missing `__all__` variable to `__init__.py`
21+
- Simplifies the lint step of the build by only running checks once (previously some checks were getting run twice)
22+
- Tests against Python `3.10`
1623

1724
## v1.6.0 (2021-10-08)
1825

19-
* Adds `Black` and `iSort` as dev dependencies
20-
* Adds a `pyproject.toml` file to configure Python tools
21-
* Completely refactors the `Makefile` to include new tools and better ways of invoking previous ones
22-
* Removes `.github/FUNDING.yml` file in favor of `.github` global files
26+
- Adds `Black` and `iSort` as dev dependencies
27+
- Adds a `pyproject.toml` file to configure Python tools
28+
- Completely refactors the `Makefile` to include new tools and better ways of invoking previous ones
29+
- Removes `.github/FUNDING.yml` file in favor of `.github` global files
2330

2431
## v1.5.0 (2021-09-10)
2532

26-
* Drops support for Python 3.6
27-
* Removes the `mock` library in favor of the builtin `unittest.mock` library
28-
* Fix some typos
33+
- Drops support for Python 3.6
34+
- Removes the `mock` library in favor of the builtin `unittest.mock` library
35+
- Fix some typos
2936

3037
## v1.4.0 (2021-07-12)
3138

32-
* Clarified various pieces of info
33-
* Unified more text replacements for easier usage of the template when getting started
39+
- Clarified various pieces of info
40+
- Unified more text replacements for easier usage of the template when getting started
3441

3542
## v1.3.0 (2021-05-31)
3643

37-
* Pins dependencies and moves them to a constant
38-
* Adds missing lines to code coverage report
44+
- Pins dependencies and moves them to a constant
45+
- Adds missing lines to code coverage report
3946

4047
## v1.2.0 (2021-01-30)
4148

42-
* Fixed the Coveralls command in GitHub Actions, builds now pass with their new platform requirement flag
43-
* Added a `release.yml` file to automate PyPI releasing via GitHub Actions
49+
- Fixed the Coveralls command in GitHub Actions, builds now pass with their new platform requirement flag
50+
- Added a `release.yml` file to automate PyPI releasing via GitHub Actions
4451

4552
## v1.1.1 (2021-01-09)
4653

47-
* Removed all references to Travis-CI and replace with GitHub Actions
48-
* Bumped the year in LICENSE
49-
* Added clarifying statement in README to remove all extra assets
54+
- Removed all references to Travis-CI and replace with GitHub Actions
55+
- Bumped the year in LICENSE
56+
- Added clarifying statement in README to remove all extra assets
5057

5158
## v1.1.0 (2021-01-05)
5259

53-
* Added GitHub Actions
54-
* Added `conftest.py`
55-
* Updated `README` with much more verbose instructions on changing details of the project to get you started
56-
* Added test coverage
57-
* Correcting lint Makefile target to point to the unit folder
60+
- Added GitHub Actions
61+
- Added `conftest.py`
62+
- Updated `README` with much more verbose instructions on changing details of the project to get you started
63+
- Added test coverage
64+
- Correcting lint Makefile target to point to the unit folder
5865

5966
## v1.0.0 (2020-11-19)
6067

61-
* Initial release
62-
* Makefile, README, setup.py, .travis.yml, LICENSE, test suite, module, assets, and more included to save time and energy on your next Python project
68+
- Initial release
69+
- Makefile, README, setup.py, .travis.yml, LICENSE, test suite, module, assets, and more included to save time and energy on your next Python project

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ coverage:
1818

1919
## clean - Remove the virtual environment and clear out .pyc files
2020
clean:
21-
rm -rf $(VIRTUAL_ENV) dist build *.egg-info .coverage
21+
rm -rf $(VIRTUAL_ENV) dist *.egg-info .coverage
2222
find . -name '*.pyc' -delete
2323

2424
## black - Runs the Black Python formatter against the project

setup.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,17 @@
2929
url='http://github.com/USERNAME/PROJECT_NAME_URL',
3030
author='USERNAME',
3131
license='MIT',
32-
packages=setuptools.find_packages(),
33-
package_data={'PROJECT_NAME_URL': ['py.typed']},
32+
packages=setuptools.find_packages(
33+
exclude=[
34+
'examples',
35+
'test',
36+
]
37+
),
38+
package_data={
39+
'PROJECT_NAME_URL': [
40+
'py.typed',
41+
]
42+
},
3443
classifiers=[
3544
"Programming Language :: Python :: 3",
3645
"License :: OSI Approved :: MIT License",

0 commit comments

Comments
 (0)