<!--
###############################################################################
#
# file: README.md
#
# Purpose: holds basic information about termsaver application,
# in markdown format for GitHub.
#
# Note: This file is part of Termsaver application, and should not be used
# or executed separately.
#
###############################################################################
#
# Copyright 2012 Termsaver
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
###############################################################################
-->
TermSaver
=========
*A simple text-based screensaver for terminal windows.*
Background
----------
The motivation behind this project is basically pure boredom (laughs).
Seriously, it may look like nonsense to have a screensaver look-alike program
running on a terminal window. Nonetheless, sometimes, we still want to see some
kind of movement, or action on the screen... which invigorates one's state of
mind and helps concentration back to the black screen (well, some people like
it white, meh!).
If you are:
* looking for some extra display on your main terminal window, to keep the
screen busy while you are up to something else; or
* looking for some distractions that may entertain you after too many hours
in front of the terminal; or
* with plenty of screen space (so long 80x25 default terminal window! long
live 1920px...), and use many terminals on screen; or
* just wanting to pretend you are busy with something (this is terrible)
then, TermSaver is the **right** application for you.
Requirements
------------
* Linux, or Mac (or Windows too, but you are on your own)
* Python 3.x (Python 2.x was deprecated since 08-2020)
Installation
------------
#### Pip (Pip Installs Packages, for Python Package Index)
For those using others, and still want to do it the easy way, I recommend:
sudo pip install termsaver
#### From the Source
For the brave (laughs), you can compile/install from the source:
1. Download the Source
[here](http://pypi.python.org/pypi/termsaver/) or [here](https://github.com/brunobraga/termsaver/)
2. Unpack it
tar -zxvf termsaver-{version}.tar.gz
3. Build it
cd termsaver-{version}/
python -m build
3. Install it
cd dist/
pip install termsaver-{version}-py3-none-any.whl
Features
--------
The TermSaver is a very simple application, built with the idea to allow more
screensavers to be added to its core. Developers, please read the section below.
The current published screensavers are:
#### Ascii Art Farts
This is a screensaver that displays ascii art from asciiartfarts.com
RSS feed in an animation format.
#### Clock
This is a screensaver that displays a digital clock using ascii letters.
#### Img2Ascii
This is a screensaver that displays images using ascii letters.
#### Jokes For All
This is a screensaver that displays recent jokes from <http://jokes4all.net>
website, from its hourly updated [RSS](http://en.wikipedia.org/wiki/RSS) feed.
#### Matrix
This is a screensaver that displays falling (rising) Japanese characters
simulating the screen from the movie
[The Matrix](http://en.wikipedia.org/wiki/The_Matrix).
#### Programmer
This is a screensaver that displays source code from a specified path in
visual animation. If the [pygments](https://pygments.org/) package is installed, this screensaver
will apply syntax highlighting based on the file type.
#### Quotes For All
This is a screensaver that displays recent quotes from <http://quotes4all.net>
website, from its hourly updated [RSS](http://en.wikipedia.org/wiki/RSS) feed.
#### Random Text
This is a screensaver that displays a text (your name, or whatever) on a
randomized position of the screen, changing position every N seconds.
#### Request for Comments
This is a screensaver that fetches documents from RFC (Request for Comments)
in visual animation, which are documents elaborated by the Internet
Engineering Task Force, available at <http://tools.ietf.org/rfc/>. This
screensaver randomizes documents to display, from a list of latest valid
documents. See more information about this in
[Wikipedia](http://en.wikipedia.org/wiki/Request_for_Comments).
#### RSS Feeds
This is a screensaver that displays any
[RSS](http://en.wikipedia.org/wiki/RSS) feed you want to show in your
terminal, with customizable settings and format.
#### URL Fetcher
This is a screensaver that displays content from a specified
[URL](http://en.wikipedia.org/wiki/Uniform_resource_locator) directly
on screen, in visual animation.
#### Star Wars Asciimation
This is a screensaver that displays the Star Wars Asciimation from
<http://asciimation.co.nz>.
#### Sysmon
(For Linux/Mac systems only) Displays the CPU/Memory usage over time in a graphic
alike screensaver.
#### WWTR.IN
Shows weather information from [wttr.in](https://www.wttr.in/)
- - -
**Disclaimer Note**: termsaver holds no responsibility for the contents offered
by third-parties, nor it has controls to filter them. Use it at your own risk.
Developers
----------
A more detailed guideline for developers willing to jump in and create
screensavers for termsaver is here: <https://github.com/brunobraga/termsaver/wiki/Developers>
Roadmap
-------
There is no current roadmap defined, besides improvement tickets created in
[Issues](https://github.com/brunobraga/termsaver/issues) tab in GitHub.
Refer also to <http://github.com/brunobraga/termsaver/wiki/Brainstorming> for
some insights of stuff we are thinking about.
Contribute
----------
### Translation
The internationalization of this application follows same standards of most
applications out there, by using *gettext* and MO/PO files.
The translation is still being finished up, and when it is ready for
contributor calls, we will post detailed information about the procedure.
### Screensavers (plugin)
As of v0.2, full plugin support is available, find an example here:
https://github.com/brunobraga/termsaver-figlet
### Submit a bug
If you find any errors in this application, you are more than welcome to
participate. You can:
* report the bug: <https://github.com/brunobraga/termsaver/issues>
* Fork this project: <https://github.com/brunobraga/termsaver/fork>
Uninstall
----------
### Using Pip (Pip Install Packages, for Python Package Index)
sudo pip uninstall termsaver
### Manual Uninstall
Just remove manually the following files:
# For Linux boxes
rm -rvf /usr/local/bin/termsaver
# change your python version/location here
rm -rvf /usr/local/lib/python3.x/dist-packages/termsaver*
rm -rvf /usr/local/share/man/man1/termsaver.1
find /usr/local/share/locale/ -name "termsaver.mo" -exec rm -rfv {} \;
If the actuall location differ from the above, it might be worth it to just
run the find command and look for them yourself (should not be hard):
find /usr/ -name "*termsaver*"
Raw data
{
"_id": null,
"home_page": null,
"name": "termsaver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Eddie Dover <ed@eddiedover.dev>",
"keywords": "command-line, terminal, screensaver",
"author": null,
"author_email": "Bruno Braga <bruno@brunobraga.net>",
"download_url": "https://files.pythonhosted.org/packages/2b/f7/d22467a93f60e9c14e1ed0c97caa460dab86783ab53624d857432f30ed42/termsaver-0.7.tar.gz",
"platform": null,
"description": "<!-- \n###############################################################################\n#\n# file: README.md\n#\n# Purpose: holds basic information about termsaver application, \n# in markdown format for GitHub.\n#\n# Note: This file is part of Termsaver application, and should not be used\n# or executed separately.\n#\n###############################################################################\n#\n# Copyright 2012 Termsaver\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\"); you may\n# not use this file except in compliance with the License. You may obtain\n# a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations\n# under the License.\n#\n###############################################################################\n-->\n\nTermSaver\n=========\n\n*A simple text-based screensaver for terminal windows.*\n\n\n\n\nBackground\n----------\n\nThe motivation behind this project is basically pure boredom (laughs). \nSeriously, it may look like nonsense to have a screensaver look-alike program\nrunning on a terminal window. Nonetheless, sometimes, we still want to see some\nkind of movement, or action on the screen... which invigorates one's state of\nmind and helps concentration back to the black screen (well, some people like \nit white, meh!).\n\nIf you are:\n\n * looking for some extra display on your main terminal window, to keep the \n screen busy while you are up to something else; or\n * looking for some distractions that may entertain you after too many hours\n in front of the terminal; or\n * with plenty of screen space (so long 80x25 default terminal window! long \n live 1920px...), and use many terminals on screen; or\n * just wanting to pretend you are busy with something (this is terrible)\n\nthen, TermSaver is the **right** application for you.\n\n\nRequirements\n------------\n\n * Linux, or Mac (or Windows too, but you are on your own)\n * Python 3.x (Python 2.x was deprecated since 08-2020)\n\n\nInstallation\n------------\n#### Pip (Pip Installs Packages, for Python Package Index)\n\nFor those using others, and still want to do it the easy way, I recommend:\n\n sudo pip install termsaver\n\n\n#### From the Source\n\nFor the brave (laughs), you can compile/install from the source:\n\n1. Download the Source \n[here](http://pypi.python.org/pypi/termsaver/) or [here](https://github.com/brunobraga/termsaver/)\n\n2. Unpack it\n \n tar -zxvf termsaver-{version}.tar.gz\n\n3. Build it\n cd termsaver-{version}/\n python -m build\n\n3. Install it\n cd dist/\n pip install termsaver-{version}-py3-none-any.whl\n\n\nFeatures\n--------\n\nThe TermSaver is a very simple application, built with the idea to allow more \nscreensavers to be added to its core. Developers, please read the section below. \n\nThe current published screensavers are:\n\n\n#### Ascii Art Farts\n\nThis is a screensaver that displays ascii art from asciiartfarts.com \nRSS feed in an animation format. \n\n\n#### Clock\n\nThis is a screensaver that displays a digital clock using ascii letters.\n\n\n#### Img2Ascii\n\nThis is a screensaver that displays images using ascii letters.\n\n\n#### Jokes For All\n\nThis is a screensaver that displays recent jokes from <http://jokes4all.net>\nwebsite, from its hourly updated [RSS](http://en.wikipedia.org/wiki/RSS) feed.\n\n\n#### Matrix\n\nThis is a screensaver that displays falling (rising) Japanese characters\nsimulating the screen from the movie \n[The Matrix](http://en.wikipedia.org/wiki/The_Matrix).\n\n\n#### Programmer\n\nThis is a screensaver that displays source code from a specified path in\nvisual animation. If the [pygments](https://pygments.org/) package is installed, this screensaver\nwill apply syntax highlighting based on the file type.\n\n#### Quotes For All\n\nThis is a screensaver that displays recent quotes from <http://quotes4all.net>\nwebsite, from its hourly updated [RSS](http://en.wikipedia.org/wiki/RSS) feed.\n\n\n#### Random Text\n\nThis is a screensaver that displays a text (your name, or whatever) on a \n randomized position of the screen, changing position every N seconds.\n\n\n#### Request for Comments\n\nThis is a screensaver that fetches documents from RFC (Request for Comments)\nin visual animation, which are documents elaborated by the Internet \nEngineering Task Force, available at <http://tools.ietf.org/rfc/>. This \nscreensaver randomizes documents to display, from a list of latest valid\ndocuments. See more information about this in \n[Wikipedia](http://en.wikipedia.org/wiki/Request_for_Comments).\n\n\n#### RSS Feeds\n\nThis is a screensaver that displays any \n[RSS](http://en.wikipedia.org/wiki/RSS) feed you want to show in your\nterminal, with customizable settings and format.\n\n\n#### URL Fetcher\n\nThis is a screensaver that displays content from a specified \n[URL](http://en.wikipedia.org/wiki/Uniform_resource_locator) directly\non screen, in visual animation.\n\n\n#### Star Wars Asciimation\n\nThis is a screensaver that displays the Star Wars Asciimation from\n<http://asciimation.co.nz>.\n\n\n#### Sysmon\n\n(For Linux/Mac systems only) Displays the CPU/Memory usage over time in a graphic\nalike screensaver.\n\n#### WWTR.IN\n\nShows weather information from [wttr.in](https://www.wttr.in/)\n\n - - -\n\n**Disclaimer Note**: termsaver holds no responsibility for the contents offered \nby third-parties, nor it has controls to filter them. Use it at your own risk.\n\n\nDevelopers\n----------\n\nA more detailed guideline for developers willing to jump in and create \nscreensavers for termsaver is here: <https://github.com/brunobraga/termsaver/wiki/Developers>\n\n\nRoadmap\n-------\n\nThere is no current roadmap defined, besides improvement tickets created in\n[Issues](https://github.com/brunobraga/termsaver/issues) tab in GitHub.\nRefer also to <http://github.com/brunobraga/termsaver/wiki/Brainstorming> for\nsome insights of stuff we are thinking about.\n\nContribute\n----------\n\n### Translation\n\nThe internationalization of this application follows same standards of most\napplications out there, by using *gettext* and MO/PO files.\n\nThe translation is still being finished up, and when it is ready for \ncontributor calls, we will post detailed information about the procedure.\n\n\n### Screensavers (plugin)\n\nAs of v0.2, full plugin support is available, find an example here:\n\nhttps://github.com/brunobraga/termsaver-figlet\n\n\n### Submit a bug\n\nIf you find any errors in this application, you are more than welcome to \nparticipate. You can:\n\n* report the bug: <https://github.com/brunobraga/termsaver/issues>\n\n* Fork this project: <https://github.com/brunobraga/termsaver/fork>\n \nUninstall\n----------\n\n### Using Pip (Pip Install Packages, for Python Package Index)\n\n sudo pip uninstall termsaver\n\n\n### Manual Uninstall\n\nJust remove manually the following files:\n\n # For Linux boxes\n rm -rvf /usr/local/bin/termsaver\n \n # change your python version/location here\n rm -rvf /usr/local/lib/python3.x/dist-packages/termsaver* \n \n rm -rvf /usr/local/share/man/man1/termsaver.1 \n find /usr/local/share/locale/ -name \"termsaver.mo\" -exec rm -rfv {} \\; \n\nIf the actuall location differ from the above, it might be worth it to just\nrun the find command and look for them yourself (should not be hard):\n\n find /usr/ -name \"*termsaver*\" \n",
"bugtrack_url": null,
"license": "Apache License v2",
"summary": "Simple text-based terminal screensaver.",
"version": "0.7",
"project_urls": {
"Bug tracker": "https://github.com/brunobraga/termsaver/issues",
"Homepage": "https://www.github.com/brunobraga/termsaver"
},
"split_keywords": [
"command-line",
" terminal",
" screensaver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df45f30d56635ad8738fb1f7e93ad4c3db179581471ad7a7aedd197c3de5a5b2",
"md5": "1ae9f6c488fd87039b06c5e9517127e5",
"sha256": "1c241ef8a885295620976d8fbc1573a001b11ff4dccac7ade82cf4d8ff385309"
},
"downloads": -1,
"filename": "termsaver-0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ae9f6c488fd87039b06c5e9517127e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 220334,
"upload_time": "2024-05-22T21:01:21",
"upload_time_iso_8601": "2024-05-22T21:01:21.694439Z",
"url": "https://files.pythonhosted.org/packages/df/45/f30d56635ad8738fb1f7e93ad4c3db179581471ad7a7aedd197c3de5a5b2/termsaver-0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2bf7d22467a93f60e9c14e1ed0c97caa460dab86783ab53624d857432f30ed42",
"md5": "357e4cafeaaf0be0eb9441e127614f59",
"sha256": "3877c9968464095dd68b16755cf525560b6a3cbcf07ac46f4cb9be840bbcaef8"
},
"downloads": -1,
"filename": "termsaver-0.7.tar.gz",
"has_sig": false,
"md5_digest": "357e4cafeaaf0be0eb9441e127614f59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 180186,
"upload_time": "2024-05-22T21:01:23",
"upload_time_iso_8601": "2024-05-22T21:01:23.750663Z",
"url": "https://files.pythonhosted.org/packages/2b/f7/d22467a93f60e9c14e1ed0c97caa460dab86783ab53624d857432f30ed42/termsaver-0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-22 21:01:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brunobraga",
"github_project": "termsaver",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "termsaver"
}
JSON
