Skip to content

Update readme to start with use cases#84

Merged
lvrfrc87 merged 3 commits into
networktocode:developfrom
itdependsnetworks:readme
Sep 22, 2022
Merged

Update readme to start with use cases#84
lvrfrc87 merged 3 commits into
networktocode:developfrom
itdependsnetworks:readme

Conversation

@itdependsnetworks

Copy link
Copy Markdown
Contributor

No description provided.

Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
# jdiff

`jdiff` is a lightweight Python library allowing you to examine structured data. `jdiff` provides an interface to intelligently compare JSON data objects and test for the presence (or absence) of keys. You can also examine and compare corresponding key-values.
`jdiff` is a lightweight Python library allowing you to examine structured data. `jdiff` provides an interface to intelligently compare JSON data objects in a intelligently way.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant statement? Why remove the previous sentence?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, dup for sure. Perhaps:

jdiff` provides an interface to intelligently compare--via key presense/absense and value comparison--JSON data objects

Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
pszulczewski
pszulczewski previously approved these changes Sep 6, 2022

@pszulczewski pszulczewski left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment thread README.md Outdated

@lvrfrc87 lvrfrc87 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

I will make sure to reflect this changes into blog post as it is heavily based on README

@lvrfrc87
lvrfrc87 merged commit e9676bc into networktocode:develop Sep 22, 2022
lvrfrc87 added a commit that referenced this pull request Sep 23, 2022
* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>
lvrfrc87 added a commit that referenced this pull request Sep 27, 2022
* Release 0.0.2  (#88)

* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* add operator ge and le

* fix validate tests

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>
lvrfrc87 added a commit that referenced this pull request Apr 20, 2023
* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Implement `ge` and `le` operator type (#89)

* Release 0.0.2  (#88)

* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* add operator ge and le

* fix validate tests

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Fix parameter_match check, to support non-normalized data (#90)

* Fix parameter_match check, to support non-normalized data

* Add test

* Update tests.

* remove test print

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Update mypy

* Bugfix to data normalization

* Fix ref_key parsing

* Update docs

* Issue 92 (#98)

* Base-line tests for future refactor.

* Refactor to simplify code.

* Implement issue #92

* Bump certifi from 2022.9.24 to 2022.12.7 (#95)

Bumps [certifi](https://github.com/certifi/python-certifi) from 2022.9.24 to 2022.12.7.
- [Release notes](https://github.com/certifi/python-certifi/releases)
- [Commits](certifi/python-certifi@2022.09.24...2022.12.07)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
lvrfrc87 added a commit that referenced this pull request May 12, 2023
* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Implement `ge` and `le` operator type (#89)

* Release 0.0.2  (#88)

* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* add operator ge and le

* fix validate tests

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Fix parameter_match check, to support non-normalized data (#90)

* Fix parameter_match check, to support non-normalized data

* Add test

* Update tests.

* remove test print

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Update mypy

* Bugfix to data normalization

* Fix ref_key parsing

* Update docs

* Issue 92 (#98)

* Base-line tests for future refactor.

* Refactor to simplify code.

* Implement issue #92

* Bump certifi from 2022.9.24 to 2022.12.7 (#95)

Bumps [certifi](https://github.com/certifi/python-certifi) from 2022.9.24 to 2022.12.7.
- [Release notes](https://github.com/certifi/python-certifi/releases)
- [Commits](certifi/python-certifi@2022.09.24...2022.12.07)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update version and changelog

* update poetry lock

* Update changelog

* Issue 94 & 91 (#100)

* Baseline unittests

* Fix issue #94

* Remove test print

* Fix issue #91

* Relax deepdiff dependency.

* Update pyproject.toml

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>

* Update poetry.lock

* Relase v0.0.4

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>
Co-authored-by: Federico87 <15066806+lvrfrc87@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Network to Code <federico.olivieri@networktocode.com>
Co-authored-by: Leo Kirchner <leo.kirchner98@gmail.com>
Co-authored-by: Leo Kirchner <Kircheneer@users.noreply.github.com>
lvrfrc87 added a commit that referenced this pull request May 12, 2023
* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Implement `ge` and `le` operator type (#89)

* Release 0.0.2  (#88)

* Update readme to start with use cases (#84)

* Update readme to start with use cases

* Apply suggestions from code review

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Update README.md

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>

* Doc update (#87)

* Fix operator checks to follow other check_type logic. (#85)

* Fix operator checks to follow other check_type logic.

* Add new release 0.0.2

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* add operator ge and le

* fix validate tests

Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Fix parameter_match check, to support non-normalized data (#90)

* Fix parameter_match check, to support non-normalized data

* Add test

* Update tests.

* remove test print

Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>

* Update mypy

* Bugfix to data normalization

* Fix ref_key parsing

* Update docs

* Issue 92 (#98)

* Base-line tests for future refactor.

* Refactor to simplify code.

* Implement issue #92

* Bump certifi from 2022.9.24 to 2022.12.7 (#95)

Bumps [certifi](https://github.com/certifi/python-certifi) from 2022.9.24 to 2022.12.7.
- [Release notes](https://github.com/certifi/python-certifi/releases)
- [Commits](certifi/python-certifi@2022.09.24...2022.12.07)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update version and changelog

* update poetry lock

* Update changelog

* Issue 94 & 91 (#100)

* Baseline unittests

* Fix issue #94

* Remove test print

* Fix issue #91

* Relax deepdiff dependency.

* Update pyproject.toml

Co-authored-by: Patryk Szulczewski <patryk@szulczewski.eu>

* Update poetry.lock

* Relase v0.0.4

* Release v0.0.4 (#105)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Christian Adell <christian.adell@networktocode.com>
Co-authored-by: Ken Celenza <ken@celenza.org>
Co-authored-by: Stephen Corry <stephen.corry@networktocode.com>
Co-authored-by: Patryk Szulczewski <patryk.szulczewski@networktocode.com>
Co-authored-by: Federico87 <15066806+lvrfrc87@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Network to Code <federico.olivieri@networktocode.com>
Co-authored-by: Leo Kirchner <leo.kirchner98@gmail.com>
Co-authored-by: Leo Kirchner <Kircheneer@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants