Maintenance updates

.dockerignore

@@ -1,4 +1,4 @@
 Dockerfile
 dist
 data
-_gen
+_gen

.editorconfig

@@ -0,0 +1,7 @@
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+indent_size = 4
+indent_style = space

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+# copy changes to .stickler.yml
+max-complexity = 15
+ignore = W,E # use black for formatting
+exclude = .venv, venv, .git, __pycache__, dist, data

.gitignore

@@ -32,7 +32,8 @@ __pycache__
 [Ss]cripts
 pyvenv.cfg
 .venv
+venv
 pip-selfcheck.json
 
 /data
-/_gen
+/_gen

.stickler.yml

@@ -8,10 +8,10 @@ linters:
     fixer: true
     python: 3
 
-    # copied from tox.ini
+    # copied from .flake8
     max-complexity: 15
     ignore: W,E
-    exclude: .venv, .git, __pycache__, dist, data
+    exclude: .venv, venv, .git, __pycache__, dist, data
 
 fixers:
   enable: true

Dockerfile

@@ -13,4 +13,4 @@ CMD poetry run ditto clone --dest-dir ./data && \
     poetry run ditto transform \
         --base-url='https://pokeapi.co' \
         --src-dir=./data \
-        --dest-dir=./_gen
+        --dest-dir=./_gen

README.md

@@ -1,6 +1,4 @@
-# Ditto
-
-[https://bulbapedia.bulbagarden.net/wiki/Ditto_(Pokémon)](https://bulbapedia.bulbagarden.net/wiki/Ditto_(Pok%C3%A9mon))
+# Ditto <img src='https://veekun.com/dex/media/pokemon/global-link/132.png' height=50px/>
 
 This repository contains:
 
@@ -10,15 +8,23 @@ This repository contains:
 
 ## Usage
 
-```
+```sh
 pip install pokeapi-ditto
 ditto --help
 ```
 
+## Development
+
+```sh
+poetry install
+poetry run ditto --help
+```
+
 ## Docker
 
-You should have a Pokeapi server running on `localhost:80`.
+You should have a PokeApi server running on `localhost:80`.
 
 ```sh
+# runs clone, analyze, and transform all in one step
 docker-compose up --build
 ```