https://github.com/ietf-tools/author-tools
Author Tools
https://github.com/ietf-tools/author-tools
hacktoberfest ietf internet-draft rfc xml xml2rfc
Last synced: about 1 month ago
JSON representation
Author Tools
- Host: GitHub
- URL: https://github.com/ietf-tools/author-tools
- Owner: ietf-tools
- License: bsd-3-clause
- Created: 2021-07-26T02:00:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T23:09:42.000Z (about 2 months ago)
- Last Synced: 2025-04-02T00:21:02.993Z (about 2 months ago)
- Topics: hacktoberfest, ietf, internet-draft, rfc, xml, xml2rfc
- Language: Python
- Homepage: https://author-tools.ietf.org
- Size: 3.92 MB
- Stars: 38
- Watchers: 11
- Forks: 31
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/ietf-tools/author-tools/releases)
[](https://github.com/ietf-tools/author-tools/blob/main/LICENSE)
##### IETF Author Tools
- [**Production Website**](https://datatracker.ietf.org)
- [Changelog](https://github.com/ietf-tools/author-tools/releases)
- [Contributing](https://github.com/ietf-tools/author-tools/blob/main/CONTRIBUTING.md)
- [License](https://github.com/ietf-tools/author-tools/blob/main/LICENSE)
- [Documentation](#documentation)
- [Running Author Tools service](#running-author-tools-service)
- [Testing Web UI](#testing-web-ui)
- [Testing API](#testing-api)
---
## Documentation
* [API documenation](https://author-tools.ietf.org/doc/)
* [OpenAPI specification](https://author-tools.ietf.org/api.yml)
## Running Author Tools service
```
docker compose up --build -d
```
## Testing Web UI
* Visit http://localhost:8888
## Testing API
* Test XML RFC generation
```
curl localhost:8888/api/render/xml -X POST -F "file=@"
```
* Test HTML RFC generation
```
curl localhost:8888/api/render/html -X POST -F "file=@"
```
* Test text RFC generation
```
curl localhost:8888/api/render/text -X POST -F "file=@"
```
* Test PDF RFC generation
```
curl localhost:8888/api/render/pdf -X POST -F "file=@" -o draft-output.pdf
```
* Test validation
```
curl localhost:8888/api/validate -X POST -F "file=@"
```
## Contributing
See [contributing guide](CONTRIBUTING.md).
## License
* [IETF Author Tools License](LICENSE)