Skip to content

Commit 7d8d47f

Browse files
authored
Maintenance updates (#39)
* apparently pyproject.lock changed to poetry.lock * update dependencies * update readme and description * update classifiers * move isort config out of tox.ini and flake8 config into .flake8 * add editorconfig and enfore final newlines * bump version to match dev status classifier * a couple more missing final newlines * add dev setup step to readme
1 parent 0c0bf08 commit 7d8d47f

File tree

14 files changed

+523
-354
lines changed

14 files changed

+523
-354
lines changed

.dockerignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Dockerfile
22
dist
33
data
4-
_gen
4+
_gen

.editorconfig

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
insert_final_newline = true
6+
indent_size = 4
7+
indent_style = space

.flake8

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[flake8]
2+
# copy changes to .stickler.yml
3+
max-complexity = 15
4+
ignore = W,E # use black for formatting
5+
exclude = .venv, venv, .git, __pycache__, dist, data

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ __pycache__
3232
[Ss]cripts
3333
pyvenv.cfg
3434
.venv
35+
venv
3536
pip-selfcheck.json
3637

3738
/data
38-
/_gen
39+
/_gen

.stickler.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ linters:
88
fixer: true
99
python: 3
1010

11-
# copied from tox.ini
11+
# copied from .flake8
1212
max-complexity: 15
1313
ignore: W,E
14-
exclude: .venv, .git, __pycache__, dist, data
14+
exclude: .venv, venv, .git, __pycache__, dist, data
1515

1616
fixers:
1717
enable: true

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ CMD poetry run ditto clone --dest-dir ./data && \
1313
poetry run ditto transform \
1414
--base-url='https://pokeapi.co' \
1515
--src-dir=./data \
16-
--dest-dir=./_gen
16+
--dest-dir=./_gen

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Ditto
2-
3-
[https://bulbapedia.bulbagarden.net/wiki/Ditto_(Pokémon)](https://bulbapedia.bulbagarden.net/wiki/Ditto_(Pok%C3%A9mon))
1+
# Ditto <img src='https://veekun.com/dex/media/pokemon/global-link/132.png' height=50px/>
42

53
This repository contains:
64

@@ -10,15 +8,23 @@ This repository contains:
108

119
## Usage
1210

13-
```
11+
```sh
1412
pip install pokeapi-ditto
1513
ditto --help
1614
```
1715

16+
## Development
17+
18+
```sh
19+
poetry install
20+
poetry run ditto --help
21+
```
22+
1823
## Docker
1924

20-
You should have a Pokeapi server running on `localhost:80`.
25+
You should have a PokeApi server running on `localhost:80`.
2126

2227
```sh
28+
# runs clone, analyze, and transform all in one step
2329
docker-compose up --build
2430
```

0 commit comments

Comments
 (0)