Metadata-Version: 2.4
Name: pyarchivebox
Version: 0.0.2
Summary: A simpler way to interact with your archivebox server via python
Home-page: https://github.com/orthodoxe/pyarchivebox
Author: orthodoxe
Author-email: 139006122+orthodoxe@users.noreply.github.com
License: MIT-Modified
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.32.3
Requires-Dist: selectolax>=0.3.27
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# pyarchivebox
This package simplifies the process of accessing your archivebox instance trough python.  
It allows you to access your server on version before 0.8.0 where there is no official REST API.

## Docs
You can find the docs on [ReadTheDocs](https://pyarchivebox.readthedocs.io/en/latest/index.html)

## Quick start
To use the package just install the package using `pip`:

```bash
python3 -m pip install pyarchivebox
```

Then make an object of the class containing your login info and server ip/domain:

```python
archivebox = PyArchiveBox("admin", "developementpassword", "http://localhost:8000")
```

Then you have to obtain a session cookie and a csrf token using the login method:

```python
archivebox.login()
```

and you can start using all the package in your project.

## Contributing
All contributions, even small ones like correcting a typo, are welcome. Just make a pull request.
