pax_global_header 0000666 0000000 0000000 00000000064 13013032471 0014504 g ustar 00root root 0000000 0000000 52 comment=810ce0eec83eacf8253516781937b008b8ab0f89
retweet-0.10/ 0000775 0000000 0000000 00000000000 13013032471 0013103 5 ustar 00root root 0000000 0000000 retweet-0.10/.gitignore 0000664 0000000 0000000 00000000130 13013032471 0015065 0 ustar 00root root 0000000 0000000 *.pyc
retweet.db
*.swp
__pycache__
lastsenttweetid
/retweet.ini
lastsenttweet
.coverage
retweet-0.10/.travis.yml 0000664 0000000 0000000 00000000412 13013032471 0015211 0 ustar 00root root 0000000 0000000 language: python
python:
- "3.3"
- "3.4"
- "3.5"
# command to install dependencies
install:
- pip install -r requirements.txt
- pip install coveralls
# command to run tests
script:
coverage3 run --source=retweet setup.py test
after_success:
coveralls
retweet-0.10/CHANGELOG 0000664 0000000 0000000 00000004132 13013032471 0014315 0 ustar 00root root 0000000 0000000 Change Log
All notable changes to this project will be documented in this file.
## [0.10] - 2016-11-13
### Added
- match parameter for filtering tweets by regex
## [0.9] - 2016-09-02
### Added
- like parameter to like all retweeted tweets.
- --dry-run command line option for testing purposes.
- --version command line option to display current version.
### Changed
- split [main] section in configuration file to [twitter] and [retweet] sections.
## [0.8] - 2016-01-10
### Added
- older_than parameter to retweet only if the tweet is older than a given number of minutes.
- younger_than parameter to retweet only if the tweet is younger than a given number of minutes.
- -l or --limit command line option to retrieve only the given number of statuses from Twitter.
## [0.7] - 2015-12-22
### Changed
- bug fix
## [0.6] - 2015-11-19
### Added
- only_if_hashtags parameter to retweet only tweets containing one of the hashtags of this list.
### Changed
- rename do_not_retweet_hashes parameter to do_not_retweet_hashtags for constitency and readability of the configuration.
## [0.5] - 2015-11-13
### Added
- do_not_retweet_hashtags parameter for not retweeting if a hashtag is in the text of the tweet.
## [0.4] - 2015-10-25
### Added
- use sqlite database through sqlalchemy to store already sent tweet ids.
## [0.3] - 2015-09-08
### Added
- retweets parameter to retweet only if a tweet already has been retweeted the number of times indicated by this parameter.
- waitminsecs parameter for the minimal seconds to wait before processing the next tweets.
- waitmaxsecs parameter for the maximal seconds to wait before processing the next tweets.
## [0.3] - 2015-09-08
### Added
- retweets parameter to retweet only if a tweet already has been retweeted the number of times indicated by this parameter.
- waitminsecs parameter for the minimal seconds to wait before processing the next tweets.
- waitmaxsecs parameter for the maximal seconds to wait before processing the next tweets.
## [0.2] - 2015-08-25
### Added
- bump Python version to 3.4.
- improve pep8 compliance.
## [0.1] - 2015-07-30
### Added
- initial version.
retweet-0.10/README.md 0000664 0000000 0000000 00000003126 13013032471 0014364 0 ustar 00root root 0000000 0000000 [
](https://travis-ci.org/chaica/retweet)
### Retweet
Retweet automatically retweets tweets from a Twitter user. Read the documentation in docs/
or [read it online](https://retweet.readthedocs.org/en/latest/).
### Quick Install
* Install Retweet from PyPI
# pip3 install retweet
* Install Retweet from sources
*(see the installation guide for full details)
[Installation Guide](http://retweet.readthedocs.org/en/latest/install.html)*
# tar zxvf retweet-0.10.tar.gz
# cd retweet
# python3 setup.py install
# # or
# python3 setup.py install --install-scripts=/usr/bin
### Use Retweet
* Create or modify retweet.ini file in order to configure Retweet:
[twitter]
screen_name_of_the_user_to_retweet=journalduhacker
consumer_key=ml9jaiBnf3pmU9uIrKNIxAr3v
consumer_secret=8Cmljklzerkhfer4hlj3ljl2hfvc123rezrfsdctpokaelzerp
access_token=213416590-jgJnrJG5gz132nzerl5zerwi0ahmnwkfJFN9nr3j
access_token_secret=3janlPMqDKlunJ4Hnr90k2bnfk3jfnwkFjeriFZERj32Z
[retweet]
retweets=0
waitminsecs=60
waitmaxsecs=600
do_not_retweet_hashtags=dnr,
only_if_hashtags=python,
match=[Rr]egex
like=true
[sqlite]
sqlitepath=/var/lib/retweet/retweet.db
* Launch Retweet
$ retweet /path/to/retweet.ini
### Authors
Carl Chenet
### License
This software comes under the terms of the GPLv3+. See the LICENSE file for the complete text of the license.
retweet-0.10/docs/ 0000775 0000000 0000000 00000000000 13013032471 0014033 5 ustar 00root root 0000000 0000000 retweet-0.10/docs/Makefile 0000664 0000000 0000000 00000015217 13013032471 0015501 0 ustar 00root root 0000000 0000000 # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/backupchecker.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/backupchecker.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/backupchecker"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/backupchecker"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
retweet-0.10/docs/source/ 0000775 0000000 0000000 00000000000 13013032471 0015333 5 ustar 00root root 0000000 0000000 retweet-0.10/docs/source/authors.rst 0000664 0000000 0000000 00000000062 13013032471 0017550 0 ustar 00root root 0000000 0000000 Authors
=======
Carl Chenet
retweet-0.10/docs/source/conf.py 0000664 0000000 0000000 00000020134 13013032471 0016632 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# retweet documentation build configuration file, created by
# sphinx-quickstart on Wed Dec 17 18:25:26 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.1'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'retweet'
copyright = '2015, Carl Chenet '
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.10'
# The full version, including alpha/beta/rc tags.
release = '0.10'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'retweetdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'retweet.tex', 'retweet Documentation',
'Carl Chenet \\textless{}chaica@ohmytux.com.org\\textgreater{}', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'retweet', 'retweet Documentation',
['Carl Chenet '], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'retweet', 'retweet Documentation',
'Carl Chenet ', 'retweet', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
retweet-0.10/docs/source/configure.rst 0000664 0000000 0000000 00000004243 13013032471 0020051 0 ustar 00root root 0000000 0000000 Configure Retweet
=================
As a prerequisite to use Retweet, you need a Twitter app. Log in Twitter, go to https://apps.twitter.com, create an app and generate the access token.
In order to configure Retweet, you need to create a retweet.ini file (or any name you prefer, finishing with the extension .ini) with the following parameters::
[twitter]
screen_name_of_the_user_to_retweet=journalduhacker
consumer_key=ml9jaiBnf3pmU9uIrKNIxAr3v
consumer_secret=8Cmljklzerkhfer4hlj3ljl2hfvc123rezrfsdctpokaelzerp
access_token=213416590-jgJnrJG5gz132nzerl5zerwi0ahmnwkfJFN9nr3j
access_token_secret=3janlPMqDKlunJ4Hnr90k2bnfk3jfnwkFjeriFZERj32Z
[retweet]
retweets = 0
do_not_retweet_hashtags=dnr,
only_if_hashtags=python,
match=[Rr]egex
; only retweet tweets older than n minutes
older_than=60
; only retweet tweets younger than n minutes
younger_than=120
like=true
[sqlite]
sqlitepath=/var/lib/retweet/retweet.db
- screen_name_of_the_user_to_retweet: the screen_name of the user to retweet (in @carl_chenet, it's carl_chenet)
- consumer_key: the Twitter consumer key (see your apps.twitter.com webpage)
- consumer_secret: the Twitter consumer secret key (see your apps.twitter.com webpage)
- access_token: the Twitter access token key (see your apps.twitter.com webpage)
- access_token_secret: the Twitter access token secret key (see your apps.twitter.com webpage)
- retweets: the minimal number of retweets the tweet needs to have in order we also retweet it
- waitminsecs: the minimal number of seconds to wait after processing a tweet
- waitmaxsecs: the maximal number of seconds to wait after processing a tweet
- sqlitepath: the path to the sqlite3 database file storing the already sent tweet ids
- do_not_retweet_hashtags: do not retweet if one of the hashtags in this list is in the text of the tweet
- only_if_hashtags: only retweet tweets having one of the hashtags of the list
- match: only retweet tweets containing given regular expression match
- older_than: only retweet tweets older than a number of minutes
- younger_than: only retweet tweets younger than a number of minutes
- like: like all the retweeted tweets
retweet-0.10/docs/source/index.rst 0000664 0000000 0000000 00000000535 13013032471 0017177 0 ustar 00root root 0000000 0000000 Documentation for the Retweet project
============================================
You'll find below anything you need to install, configure or run Retweet.
Guide
=====
.. toctree::
:maxdepth: 2
install
configure
use
license
authors
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
retweet-0.10/docs/source/install.rst 0000664 0000000 0000000 00000001714 13013032471 0017536 0 ustar 00root root 0000000 0000000 How to install Retweet
=============================
From PyPI
^^^^^^^^^
$ pip3 install retweet
From sources
^^^^^^^^^^^^
* You need at least Python 3.4.
* On some Linux Distribution **setuptools** package does not come with default python install, you need to install it.
* Install **PIP**::
$ wget https://bootstrap.pypa.io/get-pip.py -O - | sudo python3
* Install **setuptools** module::
$ wget https://bootstrap.pypa.io/ez_setup.py -O - | sudo python3
(Alternatively, Setuptools may be installed to a user-local path)::
$ wget https://bootstrap.pypa.io/ez_setup.py -O - | python3 - --user
* Untar the tarball and go to the source directory with the following commands::
$ tar zxvf retweet-0.10.tar.gz
$ cd retweet
* Next, to install Retweet on your computer, type the following command with the root user::
$ python3 setup.py install
$ # or
$ python3 setup.py install --install-scripts=/usr/bin
retweet-0.10/docs/source/license.rst 0000664 0000000 0000000 00000000203 13013032471 0017502 0 ustar 00root root 0000000 0000000 License
=======
This software comes under the terms of the **GPLv3+**. See the LICENSE file for the complete text of the license.
retweet-0.10/docs/source/use.rst 0000664 0000000 0000000 00000000711 13013032471 0016660 0 ustar 00root root 0000000 0000000 Use Retweet
==================
After the configuration of Retweet, just launch the following command::
$ retweet /path/to/retweet.ini
Using the -l or --limit command line option, you can limit the retrieved statuses from Twitter::
$ retweet -l 12 /path/to/retweet.ini
Using the --dry-run command line option allows not retweeting the tweets and not feed local SQLite database, for testing purpose::
$ retweet --dry-run /path/to/retweet.ini
retweet-0.10/requirements.txt 0000664 0000000 0000000 00000000040 13013032471 0016361 0 ustar 00root root 0000000 0000000 sqlalchemy>=1.0.8
tweepy>=3.5.0
retweet-0.10/retweet.py 0000775 0000000 0000000 00000002063 13013032471 0015140 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# Launch Retweet
'''Launch Retweet'''
import sys
from retweet.main import Main
class Retweet(object):
'''Retweet class'''
def __init__(self):
'''Constructor of the Retweet class'''
self.main()
def main(self):
'''main of the Main class'''
Main()
if __name__ == '__main__':
Main()
sys.exit(0)
retweet-0.10/retweet/ 0000775 0000000 0000000 00000000000 13013032471 0014562 5 ustar 00root root 0000000 0000000 retweet-0.10/retweet/__init__.py 0000664 0000000 0000000 00000001277 13013032471 0016702 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
retweet-0.10/retweet/cliparse.py 0000664 0000000 0000000 00000005246 13013032471 0016745 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# CLI parsing
'''CLI parsing'''
# standard library imports
from argparse import ArgumentParser
import os.path
import sys
class CliParse(object):
'''CliParse class'''
def __init__(self):
'''Constructor for the CliParse class'''
self.main()
def main(self):
'''main of CliParse class'''
retweetepilog = 'For more information: https://retweet.readthedocs.org'
retweetdescription = 'Retweet retweets all tweets from a Twitter account'
parser = ArgumentParser(prog='retweet',
description=retweetdescription,
epilog=retweetepilog)
parser.add_argument('pathtoconf', metavar='FILE', type=str,
help='the path to the retweet configuration')
parser.add_argument('-l', '--limit', dest='limit', type=int, action='store',
help='the number of status to get from Twitter')
parser.add_argument('-n', '--dry-run', dest='dryrun',
action='store_true', default=False,
help='Do not actually feed database and do not send the tweets')
parser.add_argument('-v', '--version',
action='version',
version='%(prog)s 0.10',
help='print the version of retweet and exit')
args = parser.parse_args()
if not os.path.exists(args.pathtoconf):
print('the path you provided for the configuration file does not exists')
sys.exit(1)
if not os.path.isfile(args.pathtoconf):
print('the path you provided for the configuration is not a file')
sys.exit(1)
if args.limit:
if args.limit > 20:
sys.exit('-l or --limit option integer should be equal or less than 20')
self.args = args
@property
def arguments(self):
'''return the path to the config file'''
return self.args
retweet-0.10/retweet/confparse.py 0000664 0000000 0000000 00000014646 13013032471 0017127 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
'''Was this tweet posted before'''
# external library imports
import sqlalchemy
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
# retweet library imports
from retweet.senttweets import SentTweets
class TweetWasPosted:
'''Was this tweet posted before'''
def __init__(self, cfgvalues):
'''Constructor of the TweetWasPosted'''
self.cfgvalues = cfgvalues
# activate the sqlite db
engine = create_engine('sqlite:///{}'.format(self.cfgvalues['sqlitepath']))
tmpsession = sessionmaker(bind=engine)
session = tmpsession()
self.session = session
SentTweets.metadata.create_all(engine)
self.allsenttweetids=[]
for twid in self.session.query(SentTweets.id).all():
self.allsenttweetids.append(twid.id)
def wasposted(self, tweet):
'''Was this tweet posted already'''
if tweet in self.allsenttweetids:
return True
else:
return False
def storetweet(self, tweettostore):
'''Store the last sent tweet'''
lastsenttweet = SentTweets(id=tweettostore)
try:
self.session.add(lastsenttweet)
self.session.commit()
except (sqlalchemy.exc.IntegrityError) as err:
print(err)
print('tweet already posted')
retweet-0.10/retweet/validate.py 0000664 0000000 0000000 00000012134 13013032471 0016726 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see = self.cfgvalues['retweets']:
# send the tweet if all checks are ok
if not self.notretweethashes() and self.retweetonlyifhashtags() and self.retweetonlyifolderthan() and self.retweetonlyifoyoungerthan() and self.retweetonlyifmatchingregex():
self.storeit = True
if self.args.dryrun:
print("tweet {} sent!".format(self.tweet.id))
else:
# at last retweet the tweet
self.api.retweet(self.tweet.id)
if self.cfgvalues['like']:
self.api.create_favorite(self.tweet.id)
else:
self.storeit = False
except (tweepy.error.TweepError) as err:
print("{}".format(err))
print("the tweet is probably retweeted already. Twitter does not allow to retweet 2 times")
finally:
# now store the tweet
if not self.twp.wasposted(self.tweet.id) and self.storeit:
if not self.args.dryrun:
self.twp.storetweet(self.tweet.id)
WaitAMoment(self.cfgvalues['waitminsecs'], self.cfgvalues['waitmaxsecs'])
def notretweethashes(self):
'''check if the tweet has a hash for not retweeting'''
found = False
# check if the current tweet contains a do-not-retweet hash
for i in self.cfgvalues['dontretweethashes']:
if '#{}'.format(i) in self.tweet.text:
found = True
return found
def retweetonlyifhashtags(self):
'''retweet only if the tweet has the following hashtag'''
found = False
if self.cfgvalues['onlyifhashtags']:
# check if the current tweet contains one of the hashtags to be retweeted
for i in self.cfgvalues['onlyifhashtags']:
if '#{}'.format(i) in self.tweet.text:
found = True
else:
found = True
return found
def retweetonlyifolderthan(self):
'''retweet only if the tweet is older than a number of minutes'''
send = False
if self.cfgvalues['olderthan']:
# check if the tweet is older than a number of minutes
now = datetime.datetime.utcnow()
tweetbirth = self.tweet.created_at
lapse = now - tweetbirth
try:
if (lapse.seconds / 60) > self.cfgvalues['olderthan']:
send = True
else:
send = False
except ValueError:
send = False
else:
send = True
return send
def retweetonlyifoyoungerthan(self):
'''retweet only if the tweet is younger than a number of minutes'''
send = False
if self.cfgvalues['youngerthan']:
# check if the tweet is younger than a number of minutes
now = datetime.datetime.utcnow()
tweetbirth = self.tweet.created_at
lapse = now - tweetbirth
try:
if (lapse.seconds / 60) < self.cfgvalues['youngerthan']:
send = True
else:
send = False
except ValueError:
send = False
else:
send = True
return send
def retweetonlyifmatchingregex(self):
'''retweet only if the tweet contains given regex'''
match = True
if self.cfgvalues['match_regex']:
match = re.search(self.cfgvalues['match_regex'], self.tweet.text)
return True if match else False
retweet-0.10/retweet/waitamoment.py 0000664 0000000 0000000 00000002245 13013032471 0017464 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
'''Wait a moment before going on'''
# standard library imports
import time
from random import randint
class WaitAMoment:
'''Wait a moment before going on'''
def __init__(self, waitminsecs, waitmaxsecs):
'''Constructor of the WaitAMoment class'''
self.min = waitminsecs
self.max = waitmaxsecs
self.main()
def main(self):
'''main of the WaitAMoment class'''
waitsec = randint(self.min, self.max)
time.sleep(waitsec)
retweet-0.10/scripts/ 0000775 0000000 0000000 00000000000 13013032471 0014572 5 ustar 00root root 0000000 0000000 retweet-0.10/scripts/retweet 0000775 0000000 0000000 00000001527 13013032471 0016204 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright © 2015 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
# Retweet startup
'''Retweet startup'''
import sys
from retweet.main import Main
if __name__ == '__main__':
Main()
sys.exit(0)
retweet-0.10/setup.py 0000664 0000000 0000000 00000003147 13013032471 0014622 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# Setup for Retweet
'''Setup for Retweet'''
# standard library imports
import os.path
# external library imports
from setuptools import setup
CLASSIFIERS = [
'Intended Audience :: End Users/Desktop',
'Environment :: Console',
'License :: OSI Approved :: GNU General Public License (GPL)',
'Operating System :: POSIX :: Linux',
'Programming Language :: Python :: 3.5'
]
setup(
name='retweet',
version='0.10',
license='GNU GPL v3',
description='twitter bot to retweet all tweets from a user',
long_description='twitter bot to retweet all tweets from a user',
classifiers=CLASSIFIERS,
author='Carl Chenet',
author_email='chaica@ohmytux.com',
url='https://github.com/chaica/retweet',
download_url='https://github.com/chaica/retweet',
packages=['retweet'],
scripts=['scripts/retweet'],
install_requires=['tweepy>=3.5.0', 'sqlalchemy'],
test_suite = 'tests',
)
retweet-0.10/tests.py 0000775 0000000 0000000 00000012101 13013032471 0014615 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright © 2015-2016 Carl Chenet
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
## Unit tests for Retweet
'''Unit tests for Retweet '''
import datetime
import sys
import unittest
from retweet.cliparse import CliParse
from retweet.confparse import ConfParse
from retweet.waitamoment import WaitAMoment
class TestRetweet(unittest.TestCase):
'''TestRetweet class'''
def test_getconfigvars(self):
'''Test the ConfParse class'''
confp = ConfParse('tests/getconfigvars/retweet.ini')
self.assertEqual(confp.confvalues, {'user_to_retweet': 'journalduhacker',
'consumer_key': '4s3nOBU7hUkPrTqeWzw6lxzC3',
'consumer_secret': 'aoWjhD7UQcXfxipa2ufkypqiUle9cF0ZlaOngiOAiJyFb23Ftb',
'access_token': '1370158707-m8eN2YcfVcKGfWmVLERDGMd1UPKHVPzAQHoP7qa',
'access_token_secret': 'aB74LfWy551sRTU49buGE6YXIukY74TmBK6JLECeOA5ta',
'retweets': 0,
'waitminsecs': 2,
'waitmaxsecs': 3,
'sqlitepath': '/var/lib/retweet/retweet.db',
'dontretweethashes': ['dnr'],
'onlyifhashtags': ['python'],
'match_regex': '[Rr]egex',
'youngerthan': 180,
'olderthan': 60,
'like': False
})
def test_getconfigvarsnodnr(self):
'''Test the ConfParse class'''
confp = ConfParse('tests/getconfigvars/retweet-nodnr.ini')
self.assertEqual(confp.confvalues, {'user_to_retweet': 'journalduhacker',
'consumer_key': '4s3nOBU7hUkPrTqeWzw6lxzC3',
'consumer_secret': 'aoWjhD7UQcXfxipa2ufkypqiUle9cF0ZlaOngiOAiJyFb23Ftb',
'access_token': '1370158707-m8eN2YcfVcKGfWmVLERDGMd1UPKHVPzAQHoP7qa',
'access_token_secret': 'aB74LfWy551sRTU49buGE6YXIukY74TmBK6JLECeOA5ta',
'retweets': 0,
'waitminsecs': 2,
'waitmaxsecs': 3,
'sqlitepath': '/var/lib/retweet/retweet.db',
'dontretweethashes': [],
'match_regex': '',
'youngerthan': 0,
'olderthan': 0,
'onlyifhashtags': [],
'like': False
})
def test_waitamoment(self):
'''Test WaitAMoment class'''
before = datetime.datetime.now()
wam = WaitAMoment(1,2)
after = datetime.datetime.now()
res = after - before
self.assertTrue(res.seconds >= 1)
#######################################################################################
#
# Testing the consistent given version of the software both in setup.py and cliparse.py
#
#######################################################################################
def test_versionconsistency(self):
'''test the consistency of the version of the software
in both setup.py and README.MD
'''
with open('setup.py') as setuppy:
setuppycode = setuppy.readlines()
with open('README.md') as readme:
readmecode = readme.readlines()
for line in setuppycode:
if 'version=' in line:
setuppyversion = line.split("'")[1]
break
for line in readmecode:
if 'retweet-' in line:
readmeversion = line.split('retweet-')[1].split(".tar.gz")[0]
break
self.assertEqual(setuppyversion, readmeversion)
################################################################
#
# End of the unit tests
#
################################################################
if __name__ == '__main__':
unittest.main()
retweet-0.10/tests/ 0000775 0000000 0000000 00000000000 13013032471 0014245 5 ustar 00root root 0000000 0000000 retweet-0.10/tests/getconfigvars/ 0000775 0000000 0000000 00000000000 13013032471 0017106 5 ustar 00root root 0000000 0000000 retweet-0.10/tests/getconfigvars/retweet-nodnr.ini 0000664 0000000 0000000 00000000614 13013032471 0022405 0 ustar 00root root 0000000 0000000 [twitter]
screen_name_of_the_user_to_retweet=journalduhacker
consumer_key=4s3nOBU7hUkPrTqeWzw6lxzC3
consumer_secret=aoWjhD7UQcXfxipa2ufkypqiUle9cF0ZlaOngiOAiJyFb23Ftb
access_token=1370158707-m8eN2YcfVcKGfWmVLERDGMd1UPKHVPzAQHoP7qa
access_token_secret=aB74LfWy551sRTU49buGE6YXIukY74TmBK6JLECeOA5ta
[retweet]
retweets=0
waitminsecs=2
waitmaxsecs=3
[sqlite]
sqlitepath=/var/lib/retweet/retweet.db
retweet-0.10/tests/getconfigvars/retweet.ini 0000664 0000000 0000000 00000000760 13013032471 0021271 0 ustar 00root root 0000000 0000000 [twitter]
screen_name_of_the_user_to_retweet=journalduhacker
consumer_key=4s3nOBU7hUkPrTqeWzw6lxzC3
consumer_secret=aoWjhD7UQcXfxipa2ufkypqiUle9cF0ZlaOngiOAiJyFb23Ftb
access_token=1370158707-m8eN2YcfVcKGfWmVLERDGMd1UPKHVPzAQHoP7qa
access_token_secret=aB74LfWy551sRTU49buGE6YXIukY74TmBK6JLECeOA5ta
[retweet]
retweets=0
waitminsecs=2
waitmaxsecs=3
do_not_retweet_hashtags=dnr,
only_if_hashtags=python,
match=[Rr]egex
older_than=60
younger_than=180
[sqlite]
sqlitepath=/var/lib/retweet/retweet.db