Skip to content

Commit 859bbfb

Browse files
committed
Reformatted pyproject.toml, corrected directory structure, ensured pip install works.
1 parent b47caea commit 859bbfb

11 files changed

Lines changed: 69 additions & 19 deletions

File tree

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Python package
5+
6+
on:
7+
push:
8+
branches: [ main ]
9+
pull_request:
10+
branches: [ main ]
11+
12+
jobs:
13+
build:
14+
15+
runs-on: ubuntu-latest
16+
strategy:
17+
matrix:
18+
python-version: ['3.8', '3.9', '3.10']
19+
20+
steps:
21+
- uses: actions/checkout@v2
22+
- name: Set up Python {% raw %}${{ matrix.python-version }}{% endraw %}
23+
uses: actions/setup-python@v2
24+
with:
25+
python-version: {% raw %}${{ matrix.python-version }}{% endraw %}
26+
- name: Install dependencies
27+
run: |
28+
sudo apt-get update
29+
python -m pip install --upgrade pip
30+
pip install .
31+
pip install .[dev]
32+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ share/python-wheels/
2626
.installed.cfg
2727
*.egg
2828
MANIFEST
29+
_version.py
2930

3031
# PyInstaller
3132
# Usually these files are written by a python script from a template

copier.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,8 @@ module_name:
88

99
author_name:
1010
type: str
11-
help: Your first and last name? i.e. Jenny Fantastic
11+
help: Your first and last name? i.e. Jenny Fantastic
12+
13+
author_email:
14+
type: str
15+
help: Your preferred email address? i.e. jenny_fantastic@work.com

pyproject.toml.jinja

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[project]
2+
name = "{{project_name}}"
3+
license = {file = "LICENSE"}
4+
readme = "README.md"
5+
authors = [
6+
{ name = "{{author_name}}", email = "{{author_email}}" }
7+
]
8+
classifiers = [
9+
"Development Status :: 4 - Beta",
10+
"License :: OSI Approved :: MIT License",
11+
"Intended Audience :: Developers",
12+
"Intended Audience :: Science/Research",
13+
"Operating System :: OS Independent",
14+
"Programming Language :: Python",
15+
]
16+
dynamic = ["version"]
17+
dependencies = [
18+
"deprecated"
19+
]
20+
21+
# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
22+
[project.optional-dependencies]
23+
dev = [
24+
"pytest"
25+
]
26+
27+
[build-system]
28+
requires = ["setuptools","wheel"]
29+
build-backend = "setuptools.build_meta"

{{project_name}}/nb/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Put your Jupyter notebooks here :)

{{project_name}}/pyproject.toml.jinja

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from .version import __version__
File renamed without changes.

{{project_name}}/tests/__init__.py

Whitespace-only changes.
File renamed without changes.

0 commit comments

Comments
 (0)