User:Kim/Project Proposal (Gitpub)

What do you want to make?

Gitpub is a tool to create a printed or web-based publication from a git repository including repository metadata. This tool is not bound to any specific environment yet, but could have different interfaces such as a website or a terminal program.
The git api is the basis of the tool. A user can easily choose a repository as an endpoint and select different types of meta data to include, such as Commit Messages, Commit Authors, Timestamps, amount of changes made etc. There will be options for personalizing the appearance of the publication through pre-made styles or custom CSS.

How do you plan to make it?

documentation proof of concept (1)

At the moment (fri sep 26th) of first creating this Project Proposal draft I have a proof of concept prototype which consists of two bash scripts: the first script fetches the repositories meta data and writes it to a markdown file. The second script sorts all files and converts them into an impositioned pdf - ready to print as a booklet.
Here are the further steps:

1. continue making prototypes to get more familiar with the technicalities, possibilities and constrains of the API. Prototypes will be web facing (javascript) and terminal facing (bash) and explore different end formats of the publication, such as a printable pdf or a static website
2. work on more specific fatures and how to combine them
3. make the tool self contained
4. design choices regarding the tools interface but also the publication outcome (how is meta information interacting with the main text?)
5. peer distribution and testing rounds (individual or in the form of collective worksessions)
6. documentation of the tool

Probable issues I will run in to:

1. Many (not all) endpoints of the git api require authentification with a personal token

Why do you want to make it?

This meta data is produced by means of version control, an integral part of the git software, and either neglected or exploited to reinforce hypercapitalist modes of production. Making meta data part of the publication is an act of decentering the main body of text (or work) where software in use becomes not just a means to an end but presents itself as Git programming environment, collaborating on code, publishing / documenting code (there are some other uses like fonts) the program is part of the writing making apparent software, process, how we write but also are written by technology

Relation to previous practice

• in its manner of confusing centers of attention and making its own making (processual, structural or meta information) part of its content this project poses a continuation to previous projects from the past years. User:Kim/Special Issue 1/Tracing Networks Backwards, Layer browser extension
• other experiments with single source publishing include Terms of servers and SI27 Documentation/Website Manual#print_update
• interest in margins / document performance
• repurposing different platforms Api's as backends for websites (Are.na, wiki)