diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml index 049f7c1..1a9e60a 100644 --- a/.github/workflows/push.yml +++ b/.github/workflows/push.yml @@ -10,6 +10,7 @@ jobs: - uses: actions/setup-python@v4 with: python-version: "3.11" + cache: 'poetry' - uses: pre-commit/action@v3.0.0 testing: @@ -26,7 +27,8 @@ jobs: cache: 'poetry' - name: Install dependencies run: | - python -m pip install --upgrade pip poetry + python -m pip install --upgrade pip + python -m pip install poetry poetry install - name: Test with pytest run: poetry run pytest diff --git a/README.md b/README.md index 7309750..11d6a05 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# jsonstar: Extensible json module to serialize all objects. +# JSON* is an extensible json module to serialize all objects! -jsonstar extends Python's standard JSON encoder and decoder to easily handle your custom types. +`jsonstar` extends Python's standard JSON encoder and decoder to easily handle your custom types. This means you won't have to transform your custom types into dictionaries with primitive types before encoding them to JSON. And you won't have to parse back the encoded strings into your custom types after decoding them from JSON. @@ -168,7 +168,6 @@ To register a functional encoder, you simply pass the encoder to the chosen regi All functional encoders are called only for objects that do not have a registered typed encoder. - ## Contributing Pull requests are welcome and must have associated tests.