This commit is contained in:
sfigato 2019-01-11 18:19:05 +01:00 committed by blallo
parent 075ccef88e
commit a68eb9d967
Signed by: blallo
GPG Key ID: 0CBE577C9B72DC3F
3 changed files with 83 additions and 97 deletions

View File

@ -3,7 +3,7 @@ GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007 Version 3, 29 June 2007
A bot to easen the daily routine with zucchetti virtual badge. A bot to easen the daily routine with zucchetti virtual badge.
Copyright (C) 2019 Leonardo Barcaroli Copyleft 2019
This program is free software: you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by

View File

@ -20,7 +20,7 @@ import os
# directory, add these directories to sys.path here. If the directory is # directory, add these directories to sys.path here. If the directory is
# relative to the documentation root, use os.path.abspath to make it # relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here. # absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
# Get the project root dir, which is the parent dir of this # Get the project root dir, which is the parent dir of this
cwd = os.getcwd() cwd = os.getcwd()
@ -36,27 +36,26 @@ import bot_z
# -- General configuration --------------------------------------------- # -- General configuration ---------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0' # needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ["_templates"]
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = ".rst"
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = "index"
# General information about the project. # General information about the project.
project = u'Bot_Z' project = u"Bot_Z"
copyright = u"2019, Leonardo Barcaroli"
# The version info for the project you're documenting, acts as replacement # The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout # for |version| and |release|, also used in various other places throughout
@ -69,126 +68,126 @@ release = bot_z.__version__
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
#language = None # language = None
# There are two options for replacing |today|: either, you set today to # There are two options for replacing |today|: either, you set today to
# some non-false value, then it is used: # some non-false value, then it is used:
#today = '' # today = ''
# Else, today_fmt is used as the format for a strftime call. # Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y' # today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['_build'] exclude_patterns = ["_build"]
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
#default_role = None # default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True # add_function_parentheses = True
# If true, the current module name will be prepended to all description # If true, the current module name will be prepended to all description
# unit titles (such as .. function::). # unit titles (such as .. function::).
#add_module_names = True # add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the # If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default. # output. They are ignored by default.
#show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] # modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built # If true, keep warnings as "system message" paragraphs in the built
# documents. # documents.
#keep_warnings = False # keep_warnings = False
# -- Options for HTML output ------------------------------------------- # -- Options for HTML output -------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = "default"
# Theme options are theme-specific and customize the look and feel of a # 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 # theme further. For a list of options available for each theme, see the
# documentation. # documentation.
#html_theme_options = {} # html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] # html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
#html_title = None # html_title = None
# A shorter title for the navigation bar. Default is the same as # A shorter title for the navigation bar. Default is the same as
# html_title. # html_title.
#html_short_title = None # html_short_title = None
# The name of an image file (relative to this directory) to place at the # The name of an image file (relative to this directory) to place at the
# top of the sidebar. # top of the sidebar.
#html_logo = None # html_logo = None
# The name of an image file (within the static path) to use as favicon # 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 # of the docs. This file should be a Windows icon file (.ico) being
# 16x16 or 32x32 pixels large. # 16x16 or 32x32 pixels large.
#html_favicon = None # html_favicon = None
# Add any paths that contain custom static files (such as style sheets) # Add any paths that contain custom static files (such as style sheets)
# here, relative to this directory. They are copied after the builtin # here, relative to this directory. They are copied after the builtin
# static files, so a file named "default.css" will overwrite the builtin # static files, so a file named "default.css" will overwrite the builtin
# "default.css". # "default.css".
html_static_path = ['_static'] html_static_path = ["_static"]
# If not '', a 'Last updated on:' timestamp is inserted at every page # If not '', a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format. # bottom, using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y' # html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
#html_use_smartypants = True # html_use_smartypants = True
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} # html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names # Additional templates that should be rendered to pages, maps page names
# to template names. # to template names.
#html_additional_pages = {} # html_additional_pages = {}
# If false, no module index is generated. # If false, no module index is generated.
#html_domain_indices = True # html_domain_indices = True
# If false, no index is generated. # If false, no index is generated.
#html_use_index = True # html_use_index = True
# If true, the index is split into individual pages for each letter. # If true, the index is split into individual pages for each letter.
#html_split_index = False # html_split_index = False
# If true, links to the reST sources are added to the pages. # If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True # html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. # If true, "Created using Sphinx" is shown in the HTML footer.
# Default is True. # Default is True.
#html_show_sphinx = True # html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. # If true, "(C) Copyright ..." is shown in the HTML footer.
# Default is True. # Default is True.
#html_show_copyright = True # html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages # If true, an OpenSearch description file will be output, and all pages
# will contain a <link> tag referring to it. The value of this option # will contain a <link> tag referring to it. The value of this option
# must be the base URL from which the finished HTML is served. # must be the base URL from which the finished HTML is served.
#html_use_opensearch = '' # html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml"). # This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'bot_zdoc' htmlhelp_basename = "bot_zdoc"
# -- Options for LaTeX output ------------------------------------------ # -- Options for LaTeX output ------------------------------------------
@ -196,10 +195,8 @@ htmlhelp_basename = 'bot_zdoc'
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper', #'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt', #'pointsize': '10pt',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', #'preamble': '',
} }
@ -208,44 +205,38 @@ latex_elements = {
# (source start file, target name, title, author, documentclass # (source start file, target name, title, author, documentclass
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'bot_z.tex', ("index", "bot_z.tex", u"Bot_Z Documentation", u"Leonardo Barcaroli", "manual")
u'Bot_Z Documentation',
u'Leonardo Barcaroli', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at # The name of an image file (relative to this directory) to place at
# the top of the title page. # the top of the title page.
#latex_logo = None # latex_logo = None
# For "manual" documents, if this is true, then toplevel headings # For "manual" documents, if this is true, then toplevel headings
# are parts, not chapters. # are parts, not chapters.
#latex_use_parts = False # latex_use_parts = False
# If true, show page references after internal links. # If true, show page references after internal links.
#latex_show_pagerefs = False # latex_show_pagerefs = False
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#latex_show_urls = False # latex_show_urls = False
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#latex_appendices = [] # latex_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
#latex_domain_indices = True # latex_domain_indices = True
# -- Options for manual page output ------------------------------------ # -- Options for manual page output ------------------------------------
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [("index", "bot_z", u"Bot_Z Documentation", [u"Leonardo Barcaroli"], 1)]
('index', 'bot_z',
u'Bot_Z Documentation',
[u'Leonardo Barcaroli'], 1)
]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#man_show_urls = False # man_show_urls = False
# -- Options for Texinfo output ---------------------------------------- # -- Options for Texinfo output ----------------------------------------
@ -254,22 +245,25 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'bot_z', (
u'Bot_Z Documentation', "index",
u'Leonardo Barcaroli', "bot_z",
'bot_z', u"Bot_Z Documentation",
'One line description of project.', u"Leonardo Barcaroli",
'Miscellaneous'), "bot_z",
"One line description of project.",
"Miscellaneous",
)
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#texinfo_appendices = [] # texinfo_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
#texinfo_domain_indices = True # texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'. # How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote' # texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False # texinfo_no_detailmenu = False

View File

@ -5,14 +5,15 @@
from setuptools import setup, find_packages from setuptools import setup, find_packages
with open('README.rst') as readme_file: with open("README.rst") as readme_file:
readme = readme_file.read() readme = readme_file.read()
with open('HISTORY.rst') as history_file: with open("HISTORY.rst") as history_file:
history = history_file.read() history = history_file.read()
requirements = [ requirements = [
'Click>=6.0', "Click>=6.0",
"selenium>=3.141.0",
# TODO: put package requirements here # TODO: put package requirements here
] ]
@ -25,38 +26,29 @@ test_requirements = [
] ]
setup( setup(
name='bot_z', name="bot_z",
version='0.1.0', version="0.1.0",
description="A bot to easen the daily routine with zucchetti virtual badge.", description="A bot to easen the daily routine with zucchetti virtual badge.",
long_description=readme + '\n\n' + history, long_description=readme + "\n\n" + history,
author="Leonardo Barcaroli", author="Blallo",
author_email='leonardo.barcaroli@deustechnology.com', author_email="blallo@autistici.org",
url='https://github.com/lbarcaroli/bot_z', url="https://github.com/lbarcaroli/bot_z",
packages=find_packages(include=['bot_z']), packages=find_packages(include=["bot_z"]),
entry_points={ entry_points={"console_scripts": ["bot_z=bot_z.cli:main"]},
'console_scripts': [
'bot_z=bot_z.cli:main'
]
},
include_package_data=True, include_package_data=True,
install_requires=requirements, install_requires=requirements,
license="GNU General Public License v3", license="GNU General Public License v3",
zip_safe=False, zip_safe=False,
keywords='bot_z', keywords="bot_z",
classifiers=[ classifiers=[
'Development Status :: 2 - Pre-Alpha', "Development Status :: 2 - Pre-Alpha",
'Intended Audience :: Developers', "Intended Audience :: Developers",
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
'Natural Language :: English', "Natural Language :: English",
"Programming Language :: Python :: 2", "Programming Language :: Python :: 3",
'Programming Language :: Python :: 2.6', "Programming Language :: Python :: 3.7",
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
], ],
test_suite='tests', test_suite="pytest",
tests_require=test_requirements, tests_require=test_requirements,
setup_requires=setup_requirements, setup_requires=setup_requirements,
) )