twitter-amnesia


Nametwitter-amnesia JSON
Version 1.2.0 PyPI version JSON
download
home_page
SummaryA twitter service used to delete tweets not protected by a custom tag and older than a specific date.
upload_time2023-06-02 03:16:42
maintainer
docs_urlNone
author
requires_python<3.12,>=3.10.0
licenseOther/Proprietary License
keywords twitter management
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Twitter Amnesia
===============

.. image:: https://badge.fury.io/py/twitter-amnesia.svg
    :target: https://badge.fury.io/py/twitter-amnesia

.. image:: https://circleci.com/gh/ClaymorePT/twitter-amnesia.svg?style=svg
    :target: https://circleci.com/gh/ClaymorePT/twitter-amnesia

Introduction
~~~~~~~~~~~~

A service which can be deployed to erase tweets older than a specific
date and not marked with a custom tag

Requirements
~~~~~~~~~~~~

-  Python 3.11
-  For required Python modules, check requirements.txt

Installation
~~~~~~~~~~~~

**Note: Use a virtual environment**

This package is available in Pypi.
To install, just use pip.
``$ pip install twitter-amnesia``

Usage
~~~~~

When installed, twitter-amnesia can be executed by calling the
executable in the terminal. This service requires a configuration file.

Example:
::

   $ twitter-amnesia -c <service yaml config file location>


Example of a configuration YAML file contents. There's one available at `config-example/service-config.yaml <config-example/service-config.yaml>`_ .
::

    twitter:
        bearer_token: "<Bearer Token>" # Tweeter API Bearer Token. This requires at least a Free API Development Account
        username: "<Twitter Username>" # Your Twitter Handle

    protection_tag: "<Protection Tag>" # Format Example: [P]
    storage_location: "./storage" # Optional Configuration: Location to where to store Tweets before deleting them.
    days_to_expire: 30 # Tweets lifetime. Tweets older than X Days will be deleted.




Options
~~~~~~~

Other options can be cnsulted using the ``--help``

::

   $ twitter-amnesia.exe --help
   usage: twitter_amnesia [-h] -c CONFIGURATION_FILE [-l {INFO,WARNING,ERROR,CRITICAL}]

   Twitter Amnesia Service

   options:
   -h, --help            show this help message and exit
   -c CONFIGURATION_FILE, --configuration_file CONFIGURATION_FILE
                           YAML Configuration file to be used.
   -l {INFO,WARNING,ERROR,CRITICAL}, --logLevel {INFO,WARNING,ERROR,CRITICAL}
                           Logging Level (default: INFO)

Copyright
~~~~~~~~~

This project is protected under the GPLv3 License.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "twitter-amnesia",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.12,>=3.10.0",
    "maintainer_email": "",
    "keywords": "Twitter,Management",
    "author": "",
    "author_email": "\"Carlos M. Ferreira\" <carlosmf.pt@gmail.com>",
    "download_url": "",
    "platform": null,
    "description": "Twitter Amnesia\n===============\n\n.. image:: https://badge.fury.io/py/twitter-amnesia.svg\n    :target: https://badge.fury.io/py/twitter-amnesia\n\n.. image:: https://circleci.com/gh/ClaymorePT/twitter-amnesia.svg?style=svg\n    :target: https://circleci.com/gh/ClaymorePT/twitter-amnesia\n\nIntroduction\n~~~~~~~~~~~~\n\nA service which can be deployed to erase tweets older than a specific\ndate and not marked with a custom tag\n\nRequirements\n~~~~~~~~~~~~\n\n-  Python 3.11\n-  For required Python modules, check requirements.txt\n\nInstallation\n~~~~~~~~~~~~\n\n**Note: Use a virtual environment**\n\nThis package is available in Pypi.\nTo install, just use pip.\n``$ pip install twitter-amnesia``\n\nUsage\n~~~~~\n\nWhen installed, twitter-amnesia can be executed by calling the\nexecutable in the terminal. This service requires a configuration file.\n\nExample:\n::\n\n   $ twitter-amnesia -c <service yaml config file location>\n\n\nExample of a configuration YAML file contents. There's one available at `config-example/service-config.yaml <config-example/service-config.yaml>`_ .\n::\n\n    twitter:\n        bearer_token: \"<Bearer Token>\" # Tweeter API Bearer Token. This requires at least a Free API Development Account\n        username: \"<Twitter Username>\" # Your Twitter Handle\n\n    protection_tag: \"<Protection Tag>\" # Format Example: [P]\n    storage_location: \"./storage\" # Optional Configuration: Location to where to store Tweets before deleting them.\n    days_to_expire: 30 # Tweets lifetime. Tweets older than X Days will be deleted.\n\n\n\n\nOptions\n~~~~~~~\n\nOther options can be cnsulted using the ``--help``\n\n::\n\n   $ twitter-amnesia.exe --help\n   usage: twitter_amnesia [-h] -c CONFIGURATION_FILE [-l {INFO,WARNING,ERROR,CRITICAL}]\n\n   Twitter Amnesia Service\n\n   options:\n   -h, --help            show this help message and exit\n   -c CONFIGURATION_FILE, --configuration_file CONFIGURATION_FILE\n                           YAML Configuration file to be used.\n   -l {INFO,WARNING,ERROR,CRITICAL}, --logLevel {INFO,WARNING,ERROR,CRITICAL}\n                           Logging Level (default: INFO)\n\nCopyright\n~~~~~~~~~\n\nThis project is protected under the GPLv3 License.\n",
    "bugtrack_url": null,
    "license": "Other/Proprietary License",
    "summary": "A twitter service used to delete tweets not protected by a custom tag and older than a specific date.",
    "version": "1.2.0",
    "project_urls": null,
    "split_keywords": [
        "twitter",
        "management"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e8ebbe029e2a6e0b5c34f0826dc0f933dceb9ba614172fa684b3bfc09214e217",
                "md5": "e3882c544af7add82d14fbc5934c8364",
                "sha256": "f4f83780be4a5cfc3cd17c36c2aee35de3629f42c6bb6d761098c3d8f2bdf09f"
            },
            "downloads": -1,
            "filename": "twitter_amnesia-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e3882c544af7add82d14fbc5934c8364",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.10.0",
            "size": 20798,
            "upload_time": "2023-06-02T03:16:42",
            "upload_time_iso_8601": "2023-06-02T03:16:42.394169Z",
            "url": "https://files.pythonhosted.org/packages/e8/eb/be029e2a6e0b5c34f0826dc0f933dceb9ba614172fa684b3bfc09214e217/twitter_amnesia-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-02 03:16:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "twitter-amnesia"
}
        
Elapsed time: 0.07230s