{"id":14036999,"url":"https://github.com/acl-org/acl-anthology","last_synced_at":"2026-04-05T01:32:28.783Z","repository":{"id":17321657,"uuid":"20092585","full_name":"acl-org/acl-anthology","owner":"acl-org","description":"Data and software for building the ACL Anthology.","archived":false,"fork":false,"pushed_at":"2024-05-28T14:36:56.000Z","size":296216,"stargazers_count":360,"open_issues_count":246,"forks_count":243,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-05-29T06:16:37.423Z","etag":null,"topics":["acl","acl-anthology","computational-linguistics","library","library-management-system","natural-language-processing"],"latest_commit_sha":null,"homepage":"https://aclanthology.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acl-org.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":"2014-05-23T08:37:21.000Z","updated_at":"2024-05-29T06:16:37.424Z","dependencies_parsed_at":"2024-05-19T02:34:29.523Z","dependency_job_id":null,"html_url":"https://github.com/acl-org/acl-anthology","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acl-org%2Facl-anthology","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acl-org%2Facl-anthology/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acl-org%2Facl-anthology/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acl-org%2Facl-anthology/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acl-org","download_url":"https://codeload.github.com/acl-org/acl-anthology/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":214982086,"owners_count":15811653,"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":["acl","acl-anthology","computational-linguistics","library","library-management-system","natural-language-processing"],"created_at":"2024-08-12T03:02:23.710Z","updated_at":"2026-04-05T01:32:28.766Z","avatar_url":"https://github.com/acl-org.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# ACL Anthology\n\n[![ACL Anthology Website](https://img.shields.io/badge/ACL_Anthology_Website-grey.svg?style=flat\u0026logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gQ3JlYXRlZCB3aXRoIElua3NjYXBlIChodHRwOi8vd3d3Lmlua3NjYXBlLm9yZy8pIC0tPgo8c3ZnCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgdmVyc2lvbj0iMS4wIgogICB3aWR0aD0iNjgiCiAgIGhlaWdodD0iNjgiCiAgIGlkPSJzdmcyIj4KICA8ZGVmcwogICAgIGlkPSJkZWZzNCIgLz4KICA8cGF0aAogICAgIGQ9Ik0gNDEuOTc3NTUzLC0yLjg0MjE3MDllLTAxNCBDIDQxLjk3NzU1MywxLjc2MTc4IDQxLjk3NzU1MywxLjQ0MjExIDQxLjk3NzU1MywzLjAxNTggTCA3LjQ4NjkwNTQsMy4wMTU4IEwgMCwzLjAxNTggTCAwLDEwLjUwMDc5IEwgMCwzOC40Nzg2NyBMIDAsNDYgTCA3LjQ4NjkwNTQsNDYgTCA0OS41MDA4MDIsNDYgTCA1Ni45ODc3MDgsNDYgTCA2OCw0NiBMIDY4LDMwLjk5MzY4IEwgNTYuOTg3NzA4LDMwLjk5MzY4IEwgNTYuOTg3NzA4LDEwLjUwMDc5IEwgNTYuOTg3NzA4LDMuMDE1OCBDIDU2Ljk4NzcwOCwxLjQ0MjExIDU2Ljk4NzcwOCwxLjc2MTc4IDU2Ljk4NzcwOCwtMi44NDIxNzA5ZS0wMTQgTCA0MS45Nzc1NTMsLTIuODQyMTcwOWUtMDE0IHogTSAxNS4wMTAxNTUsMTcuOTg1NzggTCA0MS45Nzc1NTMsMTcuOTg1NzggTCA0MS45Nzc1NTMsMzAuOTkzNjggTCAxNS4wMTAxNTUsMzAuOTkzNjggTCAxNS4wMTAxNTUsMTcuOTg1NzggeiAiCiAgICAgc3R5bGU9ImZpbGw6I2VkMWMyNDtmaWxsLW9wYWNpdHk6MTtmaWxsLXJ1bGU6ZXZlbm9kZDtzdHJva2U6bm9uZTtzdHJva2Utd2lkdGg6MTIuODk1NDExNDk7c3Ryb2tlLWxpbmVjYXA6YnV0dDtzdHJva2UtbGluZWpvaW46bWl0ZXI7c3Ryb2tlLW1pdGVybGltaXQ6NDtzdHJva2UtZGFzaGFycmF5Om5vbmU7c3Ryb2tlLWRhc2hvZmZzZXQ6MDtzdHJva2Utb3BhY2l0eToxIgogICAgIHRyYW5zZm9ybT0idHJhbnNsYXRlKDAsIDExKSIKICAgICBpZD0icmVjdDIxNzgiIC8+Cjwvc3ZnPgo=)](https://aclanthology.org)\n[![GitHub contributors](https://img.shields.io/github/contributors/acl-org/acl-anthology)](https://github.com/acl-org/acl-anthology/graphs/contributors)\n[![Good first project issues](https://img.shields.io/github/issues/acl-org/acl-anthology/good%20first%20project)](https://github.com/acl-org/acl-anthology/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+project%22)\n[![License](https://img.shields.io/github/license/acl-org/acl-anthology)](LICENSE)\n[![acl-anthology on PyPI](https://img.shields.io/pypi/v/acl-anthology?logo=python\u0026label=acl-anthology\u0026labelColor=lightgray\u0026color=3776AB)](https://pypi.org/project/acl-anthology/)\n\nThis repository contains:\n\n- [**Metadata for all papers, authors, and venues**](data/) on the [ACL Anthology website](https://aclanthology.org/).\n- **Code and instructions** for generating the website.\n- [**A Python package for accessing the metadata**](python/), also available on PyPI.\n\nThe official home of this repository is \u003chttps://github.com/acl-org/acl-anthology\u003e.\n\n## Using the acl-anthology Python package\n\nPlease see the separate [README for the Python package](python/README.md) for detailed information.\n\n## Generating the Anthology website\n\nThese are basic instructions on generating the ACL Anthology website as seen on \u003chttps://aclanthology.org/\u003e.\n\n### Prerequisites\n\nTo build the Anthology website, you will need:\n\n+ **Python 3.11** or higher\n+ Python packages listed in `bin/requirements.txt`; to install, run `pip -r bin/requirements.txt`\n+ [**Hugo 0.126.0**](https://gohugo.io) or higher (can be [downloaded directly from\n  their repo](https://github.com/gohugoio/hugo/releases); the ***extended version*** is required!)\n+ [**bibutils**](https://sourceforge.net/p/bibutils/home/Bibutils/) for creating\n  non-BibTeX citation formats (not strictly required to build the website, but\n  without them you need to invoke the build steps manually as laid out in the\n  [detailed README](README_detailed.md))\n\n### Building and deployment with GitHub\n\nThere is a GitHub actions action performing deployment directly from GitHub.  To use this, you need to\ndefine this variable in your repository settings (web interface: settings -\u003e secrets):\n\n+ `PUBLISH_SSH_KEY`: the secret key in standard pem format for authentication (without a passphrase)\n\nGitHub will then automatically build and deploy the current master whenever the master branch changes.\nThis is done via the `upload` target in the Makefile.\n\n### Cloning\n\nClone the Anthology repo to your local machine:\n\n```bash\n$ git clone https://github.com/acl-org/acl-anthology\n```\n\n### Generating\n\nProvided you have correctly installed all requirements, building the website\nshould be as simple running `make` from the directory to which\nyou cloned the repo.\n\nThe fully generated website will be in `build/anthology` afterwards.  If any errors\noccur during this step, you can consult the [detailed\nREADME](README_detailed.md) for more information on the individual steps\nperformed to build the site.  You can see the resulting website by launching\na local webserver with `make serve`, which will serve it at http://localhost:8000.\n\nNote that building the website is quite a resource-intensive process;\nparticularly the last step, invoking Hugo, uses about 18~GB of system memory.\nBuilding the anthology takes about 10 minutes on a laptop with an SSD.\n\n(**Note:** This does *not* mean you need this amount of RAM in your system; in\nfact, the website builds fine on a laptop with 8 GB of RAM.  The system might\ntemporarily slow down due to swapping, however.  The figure of approx. 18 GB is\nthe maximum RAM usage reported when running `hugo --minify --stepAnalysis`.)\n\nThe anthology can be viewed locally by running `hugo server` in the\n`hugo/` directory.  Note that it rebuilds the site and therefore takes\nabout a minute to start.\n\n\n## Hosting a mirror of the ACL anthology\n\nFirst, creating a mirror is slow and stresses the ACL Anthology\ninfrastructure because on initial setup you have to download every\nsingle file of the anthology from the official webserver.  This can\ntake up to 8 hours no matter how fast *your* connection is.  So please\ndon't play around with this just for fun.\n\nIf you want to host a mirror, you have to set two environment variables:\n - `ANTHOLOGY_PREFIX` the http prefix your mirror will be reachable under\n   e.g. https://example.com/my-awesome-mirror or http://aclanthology.lst.uni-saarland.de\n   (Notice that there is no slash at the end!)\n - `ANTHOLOGYFILES` the directory under which papers, attachments etc.\n   will reside on your webserver.  This directory needs to be readable\n   by your webserver (obviously) but should not be a subdirectory\n   of the anthology mirror directory.\n\nWith these variables set, you run `make` to create the pages and `make\nmirror` to mirror all additional files into the build/anthology-files\ndirectory.  If you created a mirror before already, it will only\ndownload the missing files.\n\nIf you want to mirror the papers but not all attachments, you can run\n`make mirror-no-attachments` instead.\n\nYou then rsync the `build/website/` directory to your webserver or, if\nyou serve the mirror in a subdirectory `FOO`, you mirror\n`build/website/FOO`.  The `build/anthology-files` directory needs to\nbe rsync-ed to the `ANTHOLOGYFILES` directory of your webserver.\n\nAs you probably want to keep the mirror up to date, you can modify the\nshell script `bin/acl-mirror-cronjob.sh` to your needs.\n\nYou will need this software on the server\n - rsync\n - git\n - python3 \u003e 3.11.0\n - hugo \u003e 0.126.0\n - python3-venv\n\nNote that generating the anthology takes quite a bit of RAM, so make\nsure it is available on your machine.\n\n## Contributing\n\nIf you'd like to contribute to the ACL Anthology, please take a look at:\n\n- our [Github issues page](https://github.com/acl-org/acl-anthology/issues)\n- the [detailed README](README_detailed.md) which contains more in-depth information about generating and modifying the website.\n\n## History\n\nThis repo was originally wing-nus/acl and has been transferred over to acl-org as of 5 June 2017.\n\n## License\n\nThe code for building the ACL Anthology is distributed under the [Apache License, v2.0](https://www.apache.org/licenses/LICENSE-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facl-org%2Facl-anthology","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facl-org%2Facl-anthology","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facl-org%2Facl-anthology/lists"}