1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<!--
__ _ _
/ _| __ _| |_ ___ __ _| |_
| |_ / _` | __/ __/ _` | __|
| _| (_| | || (_| (_| | |_
|_| \__,_|\__\___\__,_|\__|
perpetual access to the scholarly record
-->
<div align="center">
<img src="python/fatcat_web/static/fatcat.jpg" alt="photo of a cat and cup of coffee, by Quinn Kampschroer [CC-0]">
</div>
`fatcat`: Perpetual Access to the Scholarly Record
==================================================
[](https://gitlab.com/bnewbold/fatcat/commits/master)
[](https://gitlab.com/bnewbold/fatcat/commits/master)
This repository contains source code for **fatcat**, an editable catalog of
published research (mostly journal articles), with a focus on tracking the
location and status of full-text copies on the public web, to ensure long term
access. The primary public instance runs at [fatcat.wiki](https://fatcat.wiki).
Both the software project and primary instance are a project of the [Internet
Archive](https://archive.org).
Some resources for learning more about the aims, goals, and structure of this
overall project:
* **[FORCE11 2019 Presentation Video](https://www.youtube.com/watch?v=PARqfbYIdXQ)**: "Perpetual Access Machines: Archiving Web-Published Scholarship at Scale" (30 minutes)
* **["How the Internet Archive is Ensuring Permanent Access to Open Access Journal Articles"](https://blog.archive.org/2020/09/15/how-the-internet-archive-is-ensuring-permanent-access-to-open-access-journal-articles/)**: archive.org blog post (September 2020)
* **[guide.fatcat.wiki](https://guide.fatcat.wiki)**: project documentation,
including schema overview, HOWTOs, policies, and more
* **[Fatcat "Request for Comment" (RFC)](./fatcat-rfc.md)**: original project design proposal
## Getting Started for Developers
There are three main components:
- backend API server and database (in Rust)
- API client libraries and bots (in Python)
- front-end web interface (in Python; built on API and library)
The `python/` and `rust/` folders have their own READMEs describing how to set
up development environments and requirements for those languages. Each also has
Makefiles to help with builds and running tests.
The python client library, which is automatically generated from the API
schema, lives under `./python_openapi_client/`.
To do unified development involving both the python code (web interface, bot
code) and the rust code (API server), you will likely need to install and run a
PostgreSQL (11+) database locally. For more advanced development involving
Kafka data pipelines or the metadata search index, there is a docker compose
file in `./extra/docker/` to run these services locally.
Contributors are asked run all of the following and correct any (new) lint
warnings before submitting patches:
make fmt
make lint
make test
It is very appreciated if new features and code comes with full test coverage,
but maintainers can review code and help if this is difficult.
## Contributing
Software, documentation, new bots, and other contributions to this repository
are welcome! When considering a non-trivial contribution, it can save review
time and duplicated work to jump in the chatroom or post an issue with your
idea and intentions before starting work. Large changes and features usually
have a design proposal drafted and merged first (see `./proposals/`).
There is a public chatroom where you can discuss and ask questions at
[gitter.im/internetarchive/fatcat](https://gitter.im/internetarchive/fatcat).
Contributors in this project are asked to abide by our
[Code of Conduct](https://guide.fatcat.wiki/code_of_conduct.html).
See the `LICENSE` file for detailed permissions and licensing of both python
and rust code. In short, the auto-generated client libraries are permissively
released, while the API server and web interface are strong copyleft (AGPLv3).
For software developers, the "help wanted" tag in Github Issues is a way to
discover bugs and tasks that external folks could contribute to.
## Thanks!
The "cat with coffee" photo at the top of this README is by <a
href="http://www.kampschroer.com/photography.html">Quinn Kampschroer</a>,
released under a CC-0 license (public domain).
|
