{"id":13425112,"url":"https://github.com/arachnys/athenapdf","last_synced_at":"2025-09-28T23:32:13.975Z","repository":{"id":41555485,"uuid":"55075925","full_name":"arachnys/athenapdf","owner":"arachnys","description":"Drop-in replacement for wkhtmltopdf built on Go, Electron and Docker","archived":true,"fork":false,"pushed_at":"2023-03-06T10:53:07.000Z","size":16830,"stargazers_count":2262,"open_issues_count":57,"forks_count":186,"subscribers_count":72,"default_branch":"master","last_synced_at":"2024-10-15T09:24:33.033Z","etag":null,"topics":["aws-ecs","cli","docker","electron","go","golang","html-to-pdf","javascript","kubernetes","microservice","pdf-conversion","pdf-converter","report"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arachnys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-30T15:45:11.000Z","updated_at":"2024-10-03T10:06:31.000Z","dependencies_parsed_at":"2024-06-18T18:43:09.335Z","dependency_job_id":null,"html_url":"https://github.com/arachnys/athenapdf","commit_stats":{"total_commits":102,"total_committers":31,"mean_commits":"3.2903225806451615","dds":0.6176470588235294,"last_synced_commit":"bfd04f16b01bcfb596bc5c42a94714dba45cacb3"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arachnys%2Fathenapdf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arachnys%2Fathenapdf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arachnys%2Fathenapdf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arachnys%2Fathenapdf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arachnys","download_url":"https://codeload.github.com/arachnys/athenapdf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234575214,"owners_count":18854924,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-ecs","cli","docker","electron","go","golang","html-to-pdf","javascript","kubernetes","microservice","pdf-conversion","pdf-converter","report"],"created_at":"2024-07-31T00:01:05.120Z","updated_at":"2025-09-28T23:32:13.554Z","avatar_url":"https://github.com/arachnys.png","language":"Go","funding_links":[],"categories":["Go","microservice","cli","kubernetes","Repositories"],"sub_categories":[],"readme":"# Athena - deprecated\n\n[![Build Status](https://travis-ci.org/arachnys/athenapdf.svg?branch=master)](https://travis-ci.org/arachnys/athenapdf)\n[![License](http://img.shields.io/badge/license-MIT-orange.svg?style=flat)](http://opensource.org/licenses/MIT)\n[![Gitter chat](https://badges.gitter.im/arachnys/athenapdf.png)](https://gitter.im/arachnys/athenapdf)\n\nSimple, Docker-powered PDF conversions.\n\n**This project has been deprecated and is no longer supported.**\n\nAthena is comprised of an [Electron][electron] command line interface (CLI) tool, and a [Go][go] microservice for converting HTML to PDF documents.\n\n\u003e Athena transformed Arachne into a spider for challenging her as a weaver and/or weaving a tapestry that insulted the gods.\n\n**Examples:**\n\n- Original: [Google isn’t even close as a tool for proper due diligence. Why not?][example-1] **(Converted: [PDF][example-1-pdf] | [Aggressive][example-1-aggressive])**\n- Original: [Panamanian Law Firm Is Gatekeeper To Vast Flow of Murky Offshore Secrets][example-2] **(Converted: [PDF][example-2-pdf] | [Aggressive][example-2-aggressive])**\n\n_When [aggressive mode][aggressive] is enabled, only the essential contents of a page are kept in the generated PDF document. It is a clutter-free version of the web page, perfect for reading._\n\n\n## Background\n\nAthena is an open source project.\n\nIt was designed to [do one thing and to do it well][unixphil] - PDF conversions; to work together with other programs; and to be able to handle text streams, because that is a universal interface.\n\nIt aims to give users an on-demand capability to convert HTML to PDF without frills.\n\nAt the lowest level, its [CLI][cli] component ([`athenapdf`][cli]) was designed to be an alternative / drop-in replacement for [wkhtmltopdf], a popular CLI tool for HTML to PDF conversions. Because of Docker the CLI syntax is a bit more complex but it's much more reliable.\n\n(For what it's worth, wkhtmltopdf is great, but it has a horrible habit of crashing unexpectedly - especially when printing documents with invalid HTML, problematic CSS or other issues).\n\nThere is also a [microservice][weaver] component ([`weaver`][weaver]), allowing you to leverage Athena over HTTP.\n\n## Getting Started\n\n### CLI vs Microservice\n\nOur [CLI][cli] tool will suffice for most simple, and everyday HTML to PDF conversions.\n\nHowever, for conversions at scale / PDF conversion as a service, we recommend getting started with our [microservice][weaver] component instead.\n\n![CLI vs Microservice](https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/docker.png)\n\nThe microservice is packaged with `athenapdf`, and you can run both components independently.\n\n### Docker\n\nBoth components are packaged, and distributed as [Docker][docker] images.\n\nThe only dependency you will need is Docker, and the rest will be handled for you (even if you are running in an environment without a display server - [headless environment][headless]).\n\n### Quick Start\n\nBefore starting, ensure your [Docker][docker] environment is set up, and ready-to-use.\n\n**For OSX / Windows users**, ensure your [Docker Machine][docker-machine] is prepared, and the appropriate environment variables are established.\n\n#### CLI\n\n[![asciicast](https://asciinema.org/a/c1fbvtdnrctfq6baipfox00ct.png)](https://asciinema.org/a/c1fbvtdnrctfq6baipfox00ct)\n\n1. `docker pull arachnysdocker/athenapdf`\n2. `docker run --rm -v $(pwd):/converted/ arachnysdocker/athenapdf athenapdf \u003cinput_path\u003e [output_path]`\n3. See [`cli`][cli] for full documentation\n\nThe `[output_path]` can be omitted.\n\nExample: `docker run --rm -v $(pwd):/converted/ arachnysdocker/athenapdf athenapdf https://www.arachnys.com/the-long-road-to-achieving-true-perpetual-kyc/`\n\n**For Windows users**, an additional forward slash must precede the volume when using Git Bash / MinGW:\n\n```bash\ndocker run --rm -v /$(pwd):/converted/ arachnysdocker/athenapdf athenapdf https://www.arachnys.com/the-long-road-to-achieving-true-perpetual-kyc/\n```\n\nAlternatively, if using the Windows command prompt:\n\n```cmd\ndocker run --rm -v %cd%:/converted/ arachnysdocker/athenapdf athenapdf https://www.arachnys.com/the-long-road-to-achieving-true-perpetual-kyc/\n```\n\n#### Microservice\n\n[![asciicast](https://asciinema.org/a/41247.png)](https://asciinema.org/a/41247)\n\n1. `docker pull arachnysdocker/athenapdf-service`\n2. `docker run -p 8080:8080 --rm arachnysdocker/athenapdf-service`\n3. Inline conversion: `http://\u003cdocker-address\u003e:8080/convert?auth=arachnys-weaver\u0026url=https://www.arachnys.com/the-long-road-to-achieving-true-perpetual-kyc/`\n4. OR cURL, and redirect output to file: `curl http://dockerhost:8080/convert\\?auth\\=arachnys-weaver\\\u0026url\\=https://www.arachnys.com/the-long-road-to-achieving-true-perpetual-kyc/ |\u003e out.pdf`\n5. See [`weaver`][weaver] for full documentation\n\nThe default authentication key is `arachnys-weaver`. This can be changed through the `WEAVER_AUTH_KEY` environment variable.\n\nThe microservice can be deployed scalably to [ECS][ecs] if you want to build your own conversion farm.\n\n## License\n\nPlease note `athenapdf` is NEITHER affiliated with NOR endorsed by Google Inc. and GitHub Inc.\n\nSee [`LICENSE`](LICENSE).\n\n---\n\n![Arachnys](https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/logo.png)\n\nAn [Arachnys][arachnys] Christmas project.\n\n\n[athenapdf]: http://www.athenapdf.com/\n[unixphil]: https://en.wikipedia.org/wiki/Unix_philosophy\n[example-1]: https://www.arachnys.com/the-long-road-to-achieving-true-perpetual-kyc/?utm_campaign=athena\u0026utm_medium=external%20website\u0026utm_source=github\u0026utm_content=readme\n[example-1-pdf]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/d0ae9e636bb7edceac48bd9b0780ad9dd69397cc.pdf\n[example-1-aggressive]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/d0ae9e636bb7edceac48bd9b0780ad9dd69397cc-aggressive.pdf\n[example-2]: https://panamapapers.icij.org/20160403-mossack-fonseca-offshore-secrets.html\n[example-2-pdf]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/f86e19ea13661e47c1f5f83bbde650eb3fe85aad.pdf\n[example-2-aggressive]: https://s3-eu-west-1.amazonaws.com/athena-pdf-public/examples/f86e19ea13661e47c1f5f83bbde650eb3fe85aad-aggressive.pdf\n[aggressive]: cli/docs/aggressive.md\n[electron]: https://www.electronjs.org/\n[go]: https://golang.org/\n[cli]: cli/\n[weaver]: weaver/\n[wkhtmltopdf]: http://wkhtmltopdf.org/\n[cloudconvert]: https://cloudconvert.com/\n[docker]: https://www.docker.com/\n[docker-machine]: https://docs.docker.com/mac/step_one/\n[headless]: http://internetofthingsagenda.techtarget.com/definition/headless-system\n[arachnys]: https://www.arachnys.com/?utm_campaign=athena\u0026utm_medium=external%20website\u0026utm_source=github\u0026utm_content=readme\n[ecs]: https://aws.amazon.com/ecs/details/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farachnys%2Fathenapdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farachnys%2Fathenapdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farachnys%2Fathenapdf/lists"}