Skip to content

A tool to help me automate tasks and standards across thousands of projects. Designed for personal use, but it can be used for your use as well.

License

Notifications You must be signed in to change notification settings

seanpm2001/AUTOMATE-2001

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

All Contributors


AUTOMATE-2001

HAL-9000_2001SpaceOdyssey.jpeg This image failed to load. It may be due to the file not being reached, or a general error. Reload the page to fix a possible general error.

By:

Top

README.md


Read this article in a different language

Sorted by: A-Z

Sorting options unavailable

( af Afrikaans Afrikaans | sq Shqiptare Albanian | am አማርኛ Amharic | ar عربى Arabic | hy հայերեն Armenian | az Azərbaycan dili Azerbaijani | eu Euskara Basque | be Беларуская Belarusian | bn বাংলা Bengali | bs Bosanski Bosnian | bg български Bulgarian | ca Català Catalan | ceb Sugbuanon Cebuano | ny Chichewa Chichewa | zh-CN 简体中文 Chinese (Simplified) | zh-t 中國傳統的) Chinese (Traditional) | co Corsu Corsican | hr Hrvatski Croatian | cs čeština Czech | da dansk Danish | nl Nederlands Dutch | en-us English English | EO Esperanto Esperanto | et Eestlane Estonian | tl Pilipino Filipino | fi Suomalainen Finnish | fr français French | fy Frysk Frisian | gl Galego Galician | ka ქართველი Georgian | de Deutsch German | el Ελληνικά Greek | gu ગુજરાતી Gujarati | ht Kreyòl ayisyen Haitian Creole | ha Hausa Hausa | haw Ōlelo Hawaiʻi Hawaiian | he עִברִית Hebrew | hi हिन्दी Hindi | hmn Hmong Hmong | hu Magyar Hungarian | is Íslenska Icelandic | ig Igbo Igbo | id bahasa Indonesia Icelandic | ga Gaeilge Irish | it Italiana/Italiano | ja 日本語 Japanese | jw Wong jawa Javanese | kn ಕನ್ನಡ Kannada | kk Қазақ Kazakh | km ខ្មែរ Khmer | rw Kinyarwanda Kinyarwanda | ko-south 韓國語 Korean (South) | ko-north 문화어 Korean (North) (NOT YET TRANSLATED) | ku Kurdî Kurdish (Kurmanji) | ky Кыргызча Kyrgyz | lo ລາວ Lao | la Latine Latin | lt Lietuvis Lithuanian | lb Lëtzebuergesch Luxembourgish | mk Македонски Macedonian | mg Malagasy Malagasy | ms Bahasa Melayu Malay | ml മലയാളം Malayalam | mt Malti Maltese | mi Maori Maori | mr मराठी Marathi | mn Монгол Mongolian | my မြန်မာ Myanmar (Burmese) | ne नेपाली Nepali | no norsk Norwegian | or ଓଡିଆ (ଓଡିଆ) Odia (Oriya) | ps پښتو Pashto | fa فارسی |Persian pl polski Polish | pt português Portuguese | pa ਪੰਜਾਬੀ Punjabi | No languages available that start with the letter Q | ro Română Romanian | ru русский Russian | sm Faasamoa Samoan | gd Gàidhlig na h-Alba Scots Gaelic | sr Српски Serbian | st Sesotho Sesotho | sn Shona Shona | sd سنڌي Sindhi | si සිංහල Sinhala | sk Slovák Slovak | sl Slovenščina Slovenian | so Soomaali Somali | [es en español Spanish | su Sundanis Sundanese | sw Kiswahili Swahili | sv Svenska Swedish | tg Тоҷикӣ Tajik | ta தமிழ் Tamil | tt Татар Tatar | te తెలుగు Telugu | th ไทย Thai | tr Türk Turkish | tk Türkmenler Turkmen | uk Український Ukrainian | ur اردو Urdu | ug ئۇيغۇر Uyghur | uz O'zbek Uzbek | vi Tiếng Việt Vietnamese | cy Cymraeg Welsh | xh isiXhosa Xhosa | yi יידיש Yiddish | yo Yoruba Yoruba | zu Zulu Zulu ) Available in 110 languages (108 when not counting English and North Korean, as North Korean has not been translated yet Read about it here)

Translations in languages other than English are machine translated and are not yet accurate. No errors have been fixed yet as of March 21st 2021. Please report translation errors here. Make sure to backup your correction with sources and guide me, as I don't know languages other than English well (I plan on getting a translator eventually) please cite wiktionary and other sources in your report. Failing to do so will result in a rejection of the correction being published.

Note: due to limitations with GitHub's interpretation of markdown (and pretty much every other web-based interpretation of markdown) clicking these links will redirect you to a separate file on a separate page that isn't the intended page. You will be redirected to the .github folder of this project, where the README translations are hosted.

Translations are currently done with Bing translate and DeepL. Support for Google Translate translations is coming to a close due to privacy concerns.


Index

00.0 - Top

00.1 - Title

00.2 - Read this article in a different language

00.3 - Index

01.0 - Description

02.0 - About

03.0 - Wiki

04.0 - History

04.1 - Pre-history

04.2 - Alpha History

04.3 - Beta History

04.4 - Modern History

05.0 - Security

05.1 - Supported versions (security)

05.2 - Version history (security)

05.3 - Reporting a Vulnerability (security)

05.4 - Dependencies (security)

05.5 - Other security info

06.0 - Community theme

07.0 - General description

08.0 - Confirm automation

09.0 - Repodata archival and automation

[09.1 - V1 (RepoData automate)](#V1-(RepoData automate))

[09.2 - V2 (RepoData automate)](#V2-(RepoData automate))

[09.3 - V3 (RepoData automate)](#V3-(RepoData automate))

10.0 - ProjectWiki archival and automation

10.1 - V1 (ProjectWiki automate)

10.2 - V2 (ProjectWiki automate)

10.3 - V3 (ProjectWiki automate)

10.4 - V4 (ProjectWiki automate)

10.5 - V5 (ProjectWiki automate)

11.0 - License file archival and automation

12.0 - CONTRIBUTING file archival and automation

13.0 - Info files (API:2021September)

14.0 - Extra features

15.0 - Similar projects

16.0 - Tasks to automate

17.0 - Processing tools

18.0 - AUTOMATE-2002

19.0 - Naming

19.1 - How to spell it in your fork

20.0 - Life saver

20.1 - Why this project is a lifesaver

21.0 - GitHub automation

21.1 - General GitHub automation

21.2 - GitHub Pages Automation

21.3 - API sets

22.0 - Copying

23.0 - Credits

24.0 - Installation

25.0 - Version history

26.0 - Version history

27.0 - Software status

28.0 - Sponsor info

29.0 - Contributers

30.0 - Issues

30.1 - Current issues

30.2 - Past issues

30.3 - Past pull requests

30.4 - Active pull requests

31.0 - Resources

32.0 - Contributing

33.0 - About README

34.0 - README Version history

35.0 - Footer

35.9 - End of file


AUTOMATE-2001

A tool to help me automate tasks and standards across thousands of projects. Designed for personal use, but it can be used for your use as well.


About

See above. This is a personal project for easing the automation of common or repetitive repository tasks en masse, instead of manual, and one at a time. The project has also been adapted for usage by other people, provided they have a similar workflow.


Wiki

Click/tap here to view this projects Wiki

If the project has been forked, the Wiki was likely removed. Luckily, I include an embedded version. You can view it here.


History

This project has a short history so far.

Pre-history

This project was started on 2021, Saturday, October 23rd at 6:24 pm as an attempt to solve an ongoing project maintenance project. I decided that certain tasks should be automated, and after I developed the idea and name, I started development. The project received some development on this day.

Alpha history

This project received continued development on 2021, Sunday, October 24th. It received further JSON support, a total of 7 project language files, the basis for automation, an improved set of guidelines, and increased documentation.

On 2021, Monday, October 25th, the first release was published a little late. The project also received its own GitHub organization. Development continued today, and documentation was heavily increased.

On 2021, Tuesday, October 26th, this project received its second release, but didn't receive too much development time.

On 2021, Wednesday, October 27th, the project had significant documentation improvements, and received its own website. It got a significant improvement to its main README.md file.

Beta history

No Beta history to show for this project.

Modern history

No Modern history to show for this project.


Security

Click/tap here to view the security file for this project

Supported Versions (security)

This project is still in its early stages, and none of the versions are currently supported for security, as the program is not fully functional yet, and has not been tested fully.

For general security vulnerabilities, use the security label and start your issue title with [SECURITY]. Remember to not publicly post critical/zero day vulnerabilities, see more on this below.

Version history (security)

Version Supported? Support status
v2021.10.24 (nightly) Old version, not supported
v2021.10.25 (nightly) Current version, supported
> v2021.10.25 (nightly) & > 2021 October 24th Current version set, supported
v???? NOT YET RELEASED

Reporting a Vulnerability (security)

DO NOT REPORT A ZERO DAY VULNERABILITY PUBLICLY!

Please instead direct message me via GitHub. If there is no response within 90 days, you can post the vulnerability as an issue, as part of the standard 0 day security exploit reporting guidelines.

If a vulnerability is caused by an outdated dependancy, you can report it publicly, as it usually isn't that much of a problem.

Dependencies (security)

Dependency problems aren't very bad. This project uses 7 different languages:

  • JSON

  • JavaScript

  • Python

  • QML

  • Vala

  • C#

  • Shell (BASH)

You can still report dependency problems, but dependencies usually won't be updated unless they get too old (5+ years before the most recent release) or they aren't common enough to download anymore. The current dependencies this project has include:

  • JSON ? (the program will work with any stable version of JSON)

  • JavaScript 1.8 (although the program will still run with any version of JavaScript prior to 1.8)

  • Python 3.7.2 (although the program will still run with any version of Python prior to Python 3.0)

  • QML 1.0 (although the program will still run with any version of QML prior to 1.0, and it can be bumped up if needed)

    • QTQuick 2.2 (for QML rendering, although it can be bumped up if needed)
  • Vala 0.40 (although the program will still run with newer versions of Vala, including the latest version (as of 2021 Wednesday October 27th) which is 0.52.4

  • C# 5.0 (although the program will still run with any version of C# prior to 4.0, and it can also be bumped up if needed)

  • BASH shell 5.0 (althouh the program will still run with any version of BASH shell from 3.0 or higher, and it can also be bumped up if needed)

Other security info

Other security info currently isn't available. If there are any further questions, @ me privately on GitHub. @seanpm2001


Community theme

This software development community is themed around the 2001: A Space Odyssey novel series and film series. Its community will include references to these topics, similar to how the Python community is based around Monty Python. As such, HAL 9000 is the current placeholder icon for this project.


General description

A tool to help me automate tasks and standards across thousands of projects. Designed for personal use, but it can be used for your use as well.


Confirm automation

Should this project be done manually? Absolutely NOT (I have already spent hundreds of hours on it, but there is still too much left to do manually)

Would it take at least 4x more time to do the task manually? YES

Would automation save time? Most definitely

Extra: How much time do you think you would save from automation? At least 4000 hours across 2+ years


RepoData archival and automation

V1 (RepoData automate)

Description/GitHub/

Links/GitHub/

Linked/

Topics/


V2 (RepoData automate)

Description/GitHub/

Links/GitHub/

Links/GitHub-Git/

Linked/

Topics/


V3 (RepoData automate)

Description/GitHub/

Links/GitHub/

Links/GitHub-Git/

Links/GitHub-Wiki/

Linked/

Topics/


ProjectWiki archival and automation

V1 (ProjectWiki automate)

Wiki:home

ProjectWiki/Home/Home.md & ProjectWiki/Home/Home_V1.md


V2 (ProjectWiki automate)

Wiki:home

ProjectWiki/Home/Home.md & ProjectWiki/Home/Home_V1.md

Wiki:_footer

ProjectWiki/_footer/_footer.md & ProjectWiki/_footer/_footerV1.md


V3 (ProjectWiki automate)

Wiki:home

ProjectWiki/Home/Home.md & ProjectWiki/Home/Home_V1.md

Wiki:_footer

ProjectWiki/_footer/_footer.md & ProjectWiki/_footer/_footerV1.md

ProjectWiki/README.md


V4 (ProjectWiki automate)

Wiki:home

ProjectWiki/Home/Home.md & ProjectWiki/Home/Home_V1.md

Wiki:_footer

ProjectWiki/_footer/_footer.md & ProjectWiki/_footer/_footerV1.md

Wiki:_sidebar

ProjectWiki/_sidebar/_sidebar.md & ProjectWiki/_sidebar/_sidebarV1.md

ProjectWiki/README.md


V5 (ProjectWiki automate)

Wiki:home

ProjectWiki/Home/Home.md & ProjectWiki/Home/Home_V1.md

Wiki:_footer

ProjectWiki/_footer/_footer.md & ProjectWiki/_footer/_footerV1.md

Wiki:_sidebar

ProjectWiki/_sidebar/_sidebar.md & ProjectWiki/_sidebar/_sidebarV1.md

ProjectWiki/README.md

ProjectWiki/README_V1.md


License file archival and automation

LICENSE -> LICENSE.txt or LICENSE.md (give a choice)

Create /OldVersions/LICENSE/<licenseTypeAbbreviation>/LICENSE_V1.<fileExtension>

Also: choose a license (GPL3 is the default, no license is not an option)


CONTRIBUTING file archival and automation

New file -> CONTRIBUTING.md

Variants:

SNU (default)

SNU (Programming Tools)

Journaling (default)

Meadows (default)

Other (default)

or Insert a file template for automation use


Info files (API:2021September)

AUTHORS (Insert a template)

Create: /OldVersions/AUTHORS/<language>/1/1-100/AUTHORS_V1

CREDITS (Insert a template)

Create: /OldVersions/CREDITS/<language>/1/1-100/CREDITS_V1

COPYING (Insert a template)

Create: /OldVersions/COPYING/<language>/1/1-100/COPYING_V1

INSTALL (Insert a template)

Create: /OldVersions/INSTALL/<language>/1/1-100/INSTALL_V1

These files have unique file icons under UNIX-like systems, and do not need file extensions. Adding a file extension would remove the unique icon, although adding numbers to the end of the file name does not affect it, so long as there are no punctuation characters, especially . (as of Ubuntu 20.04 LTS with GNOME 3.36.1)


Extra features

Can you get the AUTOMATE-2001 project to automate itself?

Call attention to projects with missing data (social preview image, etc.) and offer a way to replace/add them via the AUTOMATE-2001 API


Similar projects

This project is not to be confused with my other automation projects:

Backup Automation Build Bot Y (BABBY) - This is a backup automation tool. It automates data backups.

No other similar projects to list.


Tasks to automate

  • Discussion archival

First discussion

?/Other

  • if by @Seanpm2001 or @<selectUsername>

API JSON

  • /Repodata/ archival

Description/GitHub/

Links/

/GitHub

/GitHub-Git

/GitHub-Wiki

Linked/

Topics/

  • ProjectWiki archival

Main page

Default pages

Sidebar

Footer

Other related pages for the project theme

  • General maintenance

Pushing to keep GitHub pages active

  • Release data

Release archival

Title

Link

Body

Release description generation

  • API and programming

GitHub API (JSON, JavaScript)

QT (QML, C++)

GNU Make (MAKEFILE)

Application (Python)

  • File archival

All files


Processing tools

Sandbox repo to test on

Select projects to automate through the AUTOMATE-2001 project


AUTOMATE-2002

Projects forked from this project can be referred to as AUTOMATE-2002 it is a joke label.


Naming

This project is named AUTOMATE-2001, as it was a good simple name I came up with. It stands for automation 2001, or Automate Seanpm2001. It is named in the retro style of 80s/90s/early 2000s science fiction and software naming principles, such as Windows 2000, Microsoft Office 2000, DISCO-TRON 3000, and such. It uses an odd number, as the 2000, 3000, etc. naming is pretty common, and I wanted to use an odd number that reflects my birth year and username.

How to spell it in your fork

Here are instructions for how to name the project if you are forking it.

It is spelled with all caps, like so AUTOMATE-2001 but referring to it can be done in any caps, as long as you include the words Automate and 2001 next to each other (you can even refer to it in the mocking way, like AuToMaTe-2001 you cannot replace the 0 with O or other letters. The words have to remain the same. You also don't need a hyphen between the 2 words, you can also either use a space, an underscore, or just connect the words, like so: AUTOMATE2001

If your fork is at least 50.01% different (in terms of GUI, source code, file structure, file names, and documentation (combined)) than the original project, you can change the name to whatever you want, but you have to give credit to the original project regardless.


Lifesaver

Why this project is a lifesaver

I used the label life-saver for this project. It is not in reference to the candy, it is in reference to how it will save you from a life of manual, repetitive work via automation (if you have enough projects, it definitely is a life saver due to how much time it will save you)


GitHub automation

General-GitHub-automation

This is the library for GitHub automation. It is designed for the personal use of @seanpm2001 but it can work for other people as well, provided you do the same tasks as me.

It is currently written in JSON, JavaScript, and Python. This is a collection of tools to ease the maintenance of GitHub repositories.

API - For interacting with the GitHub API

Discussions - For the automation of GitHub discussions

RepoData - For the automation of GitHub repository data backups.

Pages - For keeping GitHub pages active, and not letting the site become stale and unusable.

More automation tools coming soon.

GitHub-Pages-automation

This is a script that houses a tool to automate the process of GitHub pages activity. Once every month, it adds an entry to a text file, so that the page will be re-indexed, so that the site won't become unstable and unusable due to the environment expiring.

There are already many tools to do this, I decided to include my own, as it is so simple to do.

API sets

There are 3 separate API sets

  1. QT API: A styled wrapper for QT, written in QML, JSON, and Python.

  2. GTK API: A styled wrapper for GTK, written in Vala, JSON, and Python.

  3. Vanilla Windows API: A styled wrapper for unmodified/classic Windows, written in C#, JSON, and Python.

More graphical API sets may be added in the future.


Copying

View the copying license for this project here (if you haven't built the project yet with the makefile, here is the original link: COPYINGL

Please note that you also have to follow the rules of the GNU General Public License v3 (GPL3) which you can view here


Credits

View the credits file for this project and see the people who got together to make this project by clicking/tapping here


Installation

View the installation instructions file for this project here

Requirements: Read the instructions for more info, and get the latest up-to-date instructions here


Sponsor info

SponsorButton.png

You can sponsor this project if you like, but please specify what you want to donate to. See the funds you can donate to here

You can view other sponsor info here

Try it out! The sponsor button is right up next to the watch/unwatch button.


Version history

Version history currently unavailable

No other versions listed


Software status

All of my works are free some restrictions. DRM (Digital Restrictions Management) is not present in any of my works.

DRM-free_label.en.svg

This sticker is supported by the Free Software Foundation. I never intend to include DRM in my works.

I am using the abbreviation "Digital Restrictions Management" instead of the more known "Digital Rights Management" as the common way of addressing it is false, there are no rights with DRM. The spelling "Digital Restrictions Management" is more accurate, and is supported by Richard M. Stallman (RMS) and the Free Software Foundation (FSF)

This section is used to raise awareness for the problems with DRM, and also to protest it. DRM is defective by design and is a major threat to all computer users and software freedom.

Image credit: defectivebydesign.org/drm-free/...


Contributers

Currently, I am the only contributer. Contributing is allowed, as long as you follow the rules of the CONTRIBUTING.md file.

    1. seanpm2001 - 125 commits (As of 2021, Wednesday, October 27th at 5:40 pm)
    1. No other contributers.

Issues

Current issues

  • None at the moment

  • No other current issues

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images here

Read the privacy policy on issue archival here

TL;DR

I archive my own issues. Your issue won't be archived unless you request it to be archived.

Past issues

  • None at the moment

  • No other past issues

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images here

Read the privacy policy on issue archival here

TL;DR

I archive my own issues. Your issue won't be archived unless you request it to be archived.

Past pull requests

  • None at the moment

  • No other past pull requests

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images here

Read the privacy policy on issue archival here

TL;DR

I archive my own issues. Your issue won't be archived unless you request it to be archived.

Active pull requests

  • None at the moment

  • No other active pull requests

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images here

Read the privacy policy on issue archival here

TL;DR

I archive my own issues. Your issue won't be archived unless you request it to be archived.


Resources

Here are some other resources for this project:

Project language file A

Project language file B

Project language file C

Project language file D

Project language file E

Project language file F

Project language file G

Join the discussion on GitHub

No other resources at the moment.


Contributing

Contributing is allowed for this project, as long as you follow the rules of the CONTRIBUTING.md file.

Click/tap here to view the contributing rules for this project


About README

File type: Markdown Document (*.md *.mkd *.mdown *.markdown)

File version: 1 (Wednesday, 2021 October 27th at 5:40 pm)

Line count (including blank lines and compiler line): 0,984

File purpose: Serving as the core documentation piece for AUTOMATE-2001

File language: English (US) / Markdown / HTML5

All times are UTC-7 (PDT/Pacific Time)

You may need special rendering support for the <dropdown> HTML tag being used in this document

Encoding: UTF-8


README version history

Version 0.1 (Sunday, March 21st 2021 at 7:50 pm)

Changes:

  • Started the file
  • Added the title section
  • Added the index
  • Added the about section
  • Added the Wiki section
  • Added the version history section
  • Added the issues section.
  • Added the past issues section
  • Added the past pull requests section
  • Added the active pull requests section
  • Added the contributors section
  • Added the contributing section
  • Added the about README section
  • Added the README version history section
  • Added the resources section
  • Added a software status section, with a DRM free sticker and message
  • Added the sponsor info section

ITERATION 5

  • Updated the title section
  • Updated the index
  • Added the history section
  • Updated the file info section
  • Updated the file history section

ITERATION 6

  • Updated the title section
  • Fixed and update template links
  • Updated the index
  • Added the copying section
  • Added the credits section
  • Added the installation section
  • Updated the resources section
  • Updated the contributors section
  • Added the technical notes section
  • Updated the footer
  • Updated the file info section
  • Updated the file history section
  • No other changes in version 0.1

Version 1 (2021, Wednesday, October 27th at 5:40 pm)

Changes:

  • Added a project logo
  • Updated the lead section
  • Updated the index
  • Updated the about section
  • Updated the history section
  • Added the security section
  • Added the community theme section
  • Added the general description section
  • Added the confirm automation section
  • Added the Repodata archival and automation section,
  • Added the ProjectWiki archival and automation section
  • Added the license file archival and automation section
  • Added the CONTRIBUTING file archival and automation section
  • Added the info files section
  • Added the extra features section
  • Added the similar projects section
  • Added the tasks to automate section
  • Added the processing tools section
  • Added the AUTOMATE-2002 section
  • Added the naming section
  • Added the life saver section
  • Added the GitHub automation section
  • Updated the contributors section
  • Updated the resources section
  • Updated the footer
  • Updated the file info section
  • Updated the file history section
  • No other changes in version 1

Version 2 (Coming soon)

Changes:

  • Coming soon
  • No other changes in version 2

You have reached the end of the README file

( Back to top | Exit to GitHub | Exit to Bing | Exit to DuckDuckGo | Exit to Safe.DuckDuckGo Exit to Ecosia | Exit to Swisscows )

EOF

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Sean P. Myrick V19.1.7.2

💻 📖 📆 🛡️ 🔣 🖋 🎨 🚧 🤔

All Contributors

📖

This project follows the all-contributors specification. Contributions of any kind welcome!