Metadata-Version: 2.4
Name: carbon-txt-download-disclosures
Version: 0.0.1
Summary: A carbon.txt plugin to download linked disclosures in a carbon.txt file
Requires-Python: >=3.11
Requires-Dist: carbon-txt
Provides-Extra: test
Requires-Dist: ipdb; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Requires-Dist: pytest-watch; extra == 'test'
Description-Content-Type: text/markdown

# Carbon-txt-download-disclosures

A plugin for the carbon.txt validator that downloads any linked documents in a carbon.txt file to the local file system.


## Installation

Install this plugin in the same environment as the carbon.txt validator.

The validator is listed as dependency, so if you install this package and the validator isn't already installed, you will also download the carbon.txt validator CLI tool as well.

### Using `pip`

Make sure you are in your chosen virtual environment, then run:

```bash
pip install carbon-txt-download-disclosures
```

### Using `uv`

Inside a project with a pyproject.toml file, run the following:

```bash
uv add carbon-txt-download-disclosures
```

# Usage

By default, the `carbon-txt-download-disclosures` plugin is activated whenever you run the carbon.txt validator:
```
carbon-txt validate file https://some-domain.com/carbon.txt
```

You can then run the carbon.txt CLI command

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd carbon-txt-download-disclosures
python -m venv venv
source venv/bin/activate
```

Now install the dependencies and test dependencies:

```bash
pip install -e '.[test]'
```
To run the tests:
```bash
python -m pytest
```
