Metadata-Version: 2.4
Name: pycookieparser
Version: 0.0.2
Summary: A parser for binary cookie files
Home-page: https://github.com/studiawan/pycookieparser
Author: Hudan Studiawan
Author-email: studiawan@gmail.com
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: Sphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-python
Dynamic: summary

# pybinarycookie
iOS binary cookie parser.

# How to install

Clone the repository: 

`git clone https://github.com/studiawan/pycookieparser.git`

Then go to the root project directory, create a virtual environment, and activate it:

`python3 -m venv .venv`
`source .venv/bin/activate`

Install the package:

`pip install .`

For development (includes pytest, Sphinx):

`pip install -e ".[dev]"`

# How to run

To run the tool, you can type this command in the terminal:

`pycookieparser -i /path/to/cookie_file -t {txt,json,csv} -o /path/to/output_dir [--summary]`

For example:

`pycookieparser -i tests/fdda2f81cc0b838dc00e3050b14da7ef2d835f3c -t json -o . --summary`

Or for batch directory processing:

`pycookieparser -d /path/to/directory -t json -o /path/to/output_dir --summary`

# How to run tests

Change directory to the root project directory and then run:

`pytest`

If you want to run a specific function of the module, namely `test_read_cookie_file`:

`pytest tests/test_pycookieparser.py::test_read_cookie_file`

# How to build docs

Change to `docs` directory:

`cd docs`
format 
Clean up the previous generated documentation:

`make clean`

Build the documentation:

`make html`
