organized test files, added contribution guide

anikolaienko · Nov 13, 2022 · b9ce4be · b9ce4be
1 parent d4f67b4
commit b9ce4be
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 20 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+# Contribution guide <!-- omit in toc -->
+Any contribution is welcome. If you noticed a bug or have a feature idea create a new Issue in [Github Issues](https://github.com/anikolaienko/py-automapper/issues). For small fixes it's enough to create PR with description.
+
+Table of Contents:
+- [Dev environment](#dev-environment)
+- [Pre-commit](#pre-commit)
+- [Run tests](#run-tests)
+
+# Dev environment
+* Install prerequisites from `dev-requirements.txt`:
+```bash
+pip install -r dev-requirements.txt
+```
+* Install `py-automapper` dependencies with poetry:
+```bash
+poetry install
+```
+
+# Pre-commit
+This project is using `pre-commit` checks to format and verify code. Same checks are used on CI as well. Activate `pre-commit` for your local setup:
+```bash
+pre-commit install
+```
+After this code checks will run on `git commit` command.
+
+If some of the `pre-commit` dependencies are not found make sure to activate appropriate poetry virtualenv. To check path to virtual environment run:
+```bash
+poetry env info -p
+```
+
+Or run pre-commit manually:
+```
+poetry run pre-commit run --all-files
+```
+
+# Run tests
+To run unit tests use command:
+```
+poetry run pytest tests/
+```
diff --git a/README.md b/README.md
@@ -1,35 +1,17 @@
-<img src="logo.png" align="left" style="width:128px; margin-right: 20px;" />
+<img src="logo.png" style="width:128px; margin-right: 20px;" />
 
 # py-automapper
 
-**Version**
-1.2.0
-
-**Author**
-anikolaienko
-
-**Copyright**
-anikolaienko
-
-**License**
-The MIT License (MIT)
-
-**Last updated**
-7 Oct 2022
-
-**Package Download**
-https://pypi.python.org/pypi/py-automapper
-
 **Build Status**
 [![Main branch status](https://github.com/anikolaienko/py-automapper/actions/workflows/run_code_checks.yml/badge.svg?branch=main)](https://github.com/anikolaienko/py-automapper/actions?query=branch%3Amain)
 
-
 ---
 
 Table of Contents:
 - [py-automapper](#py-automapper)
 - [Versions](#versions)
 - [About](#about)
+- [Contribute](#contribute)
 - [Usage](#usage)
   - [Different field names](#different-field-names)
   - [Overwrite field value in mapping](#overwrite-field-value-in-mapping)
@@ -51,6 +33,9 @@ Inspired by: [object-mapper](https://github.com/marazt/object-mapper)
 
 The major advantage of py-automapper is its extensibility, that allows it to map practically any type, discover custom class fields and customize mapping rules. Read more in [documentation](https://anikolaienko.github.io/py-automapper).
 
+# Contribute
+Read [CONTRIBUTING.md](/CONTRIBUTING.md) guide.
+
 # Usage
 Install package:
 ```bash

diff --git a/tests/extensions/__init__.py b/tests/extensions/__init__.py
diff --git a/tests/test_for_default_extention.py → tests/extensions/test_default_extention.py b/tests/test_for_default_extention.py → tests/extensions/test_default_extention.py
diff --git a/tests/test_for_pydantic_extention.py → tests/extensions/test_pydantic_extention.py b/tests/test_for_pydantic_extention.py → tests/extensions/test_pydantic_extention.py
diff --git a/tests/test_for_sqlalchemy_extention.py → ...s/extensions/test_sqlalchemy_extention.py b/tests/test_for_sqlalchemy_extention.py → ...s/extensions/test_sqlalchemy_extention.py
diff --git a/tests/test_for_tortoise_extention.py → tests/extensions/test_tortoise_extention.py b/tests/test_for_tortoise_extention.py → tests/extensions/test_tortoise_extention.py
diff --git a/tests/test_automapper_sample.py → tests/test_automapper_basics.py b/tests/test_automapper_sample.py → tests/test_automapper_basics.py
diff --git a/tests/test_for_complex_obj.py → tests/test_complex_objects_mapping.py b/tests/test_for_complex_obj.py → tests/test_complex_objects_mapping.py
diff --git a/tests/test_automapper_dict_field.py → tests/test_dict_field_mapping.py b/tests/test_automapper_dict_field.py → tests/test_dict_field_mapping.py
diff --git a/tests/test_automapper.py → tests/test_predefined_mapping.py b/tests/test_automapper.py → tests/test_predefined_mapping.py