Skip to content

Commit

Permalink
Merge pull request #4 from bernhard-hagmann/SIANXKE-413
Browse files Browse the repository at this point in the history
SIANXKE-413: Rename package back to python-deepcompare
  • Loading branch information
nezhar authored Nov 8, 2024
2 parents a9ec6c2 + 5ff2bd6 commit 6021801
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ and patterns in the existing code-base.
### Contribution guidelines
- Your code should follow PEP 8 -- Style Guide for Python Code
- Your changes should be covered by unit-tests
- If you add a unit-test within the `test_compare_flat.py`, make sure to add the equivalent test to the `test_partial_compare_flat.py` (and vice-versa).
- If you add a unit-test within the `test_compare_deep.py`, make sure to add the equivalent test to the `test_partial_compare_deep.py` (and vice-versa).
- If you add a unit-test within the `test_compare_flat.py`, make sure to add the equivalent test to the `test_partial_compare_flat.py` (and vice versa).
- If you add a unit-test within the `test_compare_deep.py`, make sure to add the equivalent test to the `test_partial_compare_deep.py` (and vice versa).
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ deepcompare
[![Test Status](https://github.com/anexia/python-deepcompare/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/anexia/python-deepcompare/actions/workflows/test.yml)
[![Codecov](https://codecov.io/gh/anexia/python-deepcompare/branch/main/graph/badge.svg)](https://codecov.io/gh/anexia/python-deepcompare)

`deepcompare` is a library to deep compare data structures with each other. It can check if two data
`deepcompare` is a library to deeply compare data structures with each other. It can check if two data
structures contain the same data, or if a data structure is a subset of another data structure. The library
supports `Sequence` (e.g. `list` or `tuple`) and `Mapping` (e.g. `dict`) types for the deep comparison.

Expand All @@ -14,13 +14,13 @@ supports `Sequence` (e.g. `list` or `tuple`) and `Mapping` (e.g. `dict`) types f
With a [correctly configured](https://pipenv.pypa.io/en/latest/basics/#basic-usage-of-pipenv) `pipenv` toolchain:

```sh
pipenv install deepcompare
pipenv install python-deepcompare
```

You may also use classic `pip` to install the package:

```sh
pip install deepcompare
pip install python-deepcompare
```

# Getting started
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))

setup(
name="deepcompare",
name="python-deepcompare",
version=os.getenv("PACKAGE_VERSION", "0.0.0").replace("refs/tags/", ""),
packages=find_packages(),
include_package_data=True,
Expand Down

0 comments on commit 6021801

Please sign in to comment.