https://github.com/capjamesg/indieweb-etherpad-archiver
Perl tool for archiving Etherpad links to the IndieWeb wiki.
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.8%) to scientific vocabulary
Keywords
Repository
Perl tool for archiving Etherpad links to the IndieWeb wiki.
Basic Info
Statistics
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
- Releases: 0
Topics
Metadata Files
README.md
IndieWeb Etherpad Archiver (Cali)
A tool that accepts an IndieWeb Events page and archives the associated Etherpad page to the IndieWeb wiki.
IRC Usage
This tool provides an interface over IRC through which an Etherpad page linked to an IndieWeb events page can be archived.
To archive a document using the bot, you can use the following command in the IRC channel to which the archiver is connected:
!archive <events_page_url> <example/page> - Archive an events.indieweb.org page, save to example/page
!archive <etherpad_url> <example/page> - Archive an etherpad.indieweb.org page, save to example/page
!archive help - Show help
Getting Started
To use this project, first install the required dependencies:
- Mojo::DOM
- Bot::BasicBot
- LWP::UserAgent
Next, register a bot account on the MediaWiki to which you want to save archives. This will give you the credentials you need for the next step. Take note of the bot username and password MediaWiki provides.
Once you have your bot account credentials, create a .env file and add the following values:
LGNAME=MEDIAWIKI_LOGIN_NAME
LGPASS=MEDIAWIKI_LOGIN_PASSWORD
WIKI_URL=LINK_TO_MEDIAWIKI_API
IRC_CHANNEL=IRC_CHANNEL_NAME
IRC_SERVER=IRC_SERVER_NAME
IRC_PORT=IRC_SERVER_PORT
IRC_NICK=IRC_NICK_NAME
All of these values are required.
Next, run the archiver script:
chmod +x archiver.pl
./archiver.pl
The archiver script will connect to the provided IRC channel and expose the !archive command for use in the chat.
Technology
This project was built using Perl.
License
This project is licensed under an MIT 0 license.
Contributing
Have an idea on how to improve the archiver? Feel free to open an issue or pull request in this repository.
Contributors
- capjamesg
Owner
- Name: James
- Login: capjamesg
- Kind: user
- Location: Scotland
- Company: @Roboflow
- Website: jamesg.blog
- Repositories: 320
- Profile: https://github.com/capjamesg
from words, wonder.
GitHub Events
Total
- Push event: 3
Last Year
- Push event: 3
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 5
- Total pull requests: 1
- Average time to close issues: 5 months
- Average time to close pull requests: about 20 hours
- Total issue authors: 4
- Total pull request authors: 1
- Average comments per issue: 1.6
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- capjamesg (2)
- tantek (1)
- gRegorLove (1)
- sknebel (1)
Pull Request Authors
- gRegorLove (1)