Compare commits

...

4 Commits

Author SHA1 Message Date
2cf219d917 bump version 2024-07-02 16:36:21 +02:00
25c601ecee feat: added release script 2024-07-02 16:35:14 +02:00
96bb1fce8e feat: added documentation 2024-07-02 16:32:44 +02:00
adef56790f feat: implemented functions 2024-07-02 16:30:25 +02:00
6 changed files with 51 additions and 10 deletions

View File

@@ -1,3 +1,22 @@
# Json-Unescape # Json-Unescape
Unescape json string, which is escaped for json. This is usually necessarry for webscraping. Unescape json string, which is escaped for json. This is usually necessarry for webscraping.
## Installation
```bash
pip install json-unescape
```
## Usage
```python
>>> from json_unescape import escape_json, unescape_json
>>> escape_json('{"foo": "bar,,,eee"}')
'{"key": "{\\"foo\\": \\"bar,,,eee\\"}"}'
>>> unescape_json(escape_json('{"key": "{\\"foo\\": \\"bar,,,eee\\"}"}'))
'{"foo": "bar,,,eee"}'
```

View File

@@ -1,2 +1,2 @@
__version__ = "0.0.0" __version__ = "0.0.1"
__name__ = "json_unescape" __name__ = "json_unescape"

View File

@@ -0,0 +1,10 @@
import json
def escape_json(json_str: str) -> str:
nested_object: dict = {"key": json_str}
return json.dumps(nested_object)
def unescape_json(json_str: str) -> str:
nested_json_string: str = '{"key": ' + json_str + '}'
return json.loads(nested_json_string)["key"]

View File

@@ -1,5 +0,0 @@
from .__about__ import __name__, __version__
def cli():
print(f"Running {__name__} version {__version__} from __main__.py")

View File

@@ -12,9 +12,6 @@ classifiers = [
"Operating System :: OS Independent", "Operating System :: OS Independent",
] ]
[project.scripts]
json-unescape = "json_unescape.__main__:cli"
[build-system] [build-system]
requires = ["hatchling", "hatch-requirements-txt"] requires = ["hatchling", "hatch-requirements-txt"]
build-backend = "hatchling.build" build-backend = "hatchling.build"

20
release Executable file
View File

@@ -0,0 +1,20 @@
#!/bin/bash
# install build tools
pip install build
pip install twine
pip install hatch
# increment version in pyproject.toml
hatch version micro
git add json_unescape/__about__.py
git commit -m "bump version"
git push
# build package
python3 -m build --wheel
# upload to pypi
python3 -m twine upload dist/*
python3 -m twine upload --skip-existing --repository gitea dist/*