From 2f8bf3202b5aa7c39fea68981d3c268b3525deb5 Mon Sep 17 00:00:00 2001 From: Milka64 Date: Fri, 27 Sep 2019 17:11:10 +0200 Subject: [PATCH] first push --- bootstrap-buildout.py | 210 ++++++++++++++++++++++++++++++++ kabot/.editorconfig | 21 ++++ kabot/.github/ISSUE_TEMPLATE.md | 15 +++ kabot/.gitignore | 102 ++++++++++++++++ kabot/.travis.yml | 16 +++ kabot/AUTHORS.rst | 13 ++ kabot/CONTRIBUTING.rst | 128 +++++++++++++++++++ kabot/HISTORY.rst | 8 ++ kabot/LICENSE | 32 +++++ kabot/MANIFEST.in | 11 ++ kabot/Makefile | 88 +++++++++++++ kabot/README.rst | 37 ++++++ kabot/docs/Makefile | 20 +++ kabot/docs/authors.rst | 1 + kabot/docs/conf.py | 163 +++++++++++++++++++++++++ kabot/docs/contributing.rst | 1 + kabot/docs/history.rst | 1 + kabot/docs/index.rst | 20 +++ kabot/docs/installation.rst | 51 ++++++++ kabot/docs/make.bat | 36 ++++++ kabot/docs/readme.rst | 1 + kabot/docs/usage.rst | 7 ++ kabot/kabot/__init__.py | 7 ++ kabot/kabot/cli.py | 22 ++++ kabot/kabot/kabot.py | 40 ++++++ kabot/requirements_dev.txt | 10 ++ kabot/setup.cfg | 22 ++++ kabot/setup.py | 55 +++++++++ kabot/tests/__init__.py | 3 + kabot/tests/test_kabot.py | 22 ++++ kabot/tox.ini | 20 +++ pinned.cfg | 37 ++++++ 32 files changed, 1220 insertions(+) create mode 100644 bootstrap-buildout.py create mode 100644 kabot/.editorconfig create mode 100644 kabot/.github/ISSUE_TEMPLATE.md create mode 100644 kabot/.gitignore create mode 100644 kabot/.travis.yml create mode 100644 kabot/AUTHORS.rst create mode 100644 kabot/CONTRIBUTING.rst create mode 100644 kabot/HISTORY.rst create mode 100644 kabot/LICENSE create mode 100644 kabot/MANIFEST.in create mode 100644 kabot/Makefile create mode 100644 kabot/README.rst create mode 100644 kabot/docs/Makefile create mode 100644 kabot/docs/authors.rst create mode 100755 kabot/docs/conf.py create mode 100644 kabot/docs/contributing.rst create mode 100644 kabot/docs/history.rst create mode 100644 kabot/docs/index.rst create mode 100644 kabot/docs/installation.rst create mode 100644 kabot/docs/make.bat create mode 100644 kabot/docs/readme.rst create mode 100644 kabot/docs/usage.rst create mode 100644 kabot/kabot/__init__.py create mode 100644 kabot/kabot/cli.py create mode 100644 kabot/kabot/kabot.py create mode 100644 kabot/requirements_dev.txt create mode 100644 kabot/setup.cfg create mode 100644 kabot/setup.py create mode 100644 kabot/tests/__init__.py create mode 100644 kabot/tests/test_kabot.py create mode 100644 kabot/tox.ini create mode 100644 pinned.cfg diff --git a/bootstrap-buildout.py b/bootstrap-buildout.py new file mode 100644 index 0000000..a459921 --- /dev/null +++ b/bootstrap-buildout.py @@ -0,0 +1,210 @@ +############################################################################## +# +# Copyright (c) 2006 Zope Foundation and Contributors. +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## +"""Bootstrap a buildout-based project + +Simply run this script in a directory containing a buildout.cfg. +The script accepts buildout command-line options, so you can +use the -c option to specify an alternate configuration file. +""" + +import os +import shutil +import sys +import tempfile + +from optparse import OptionParser + +__version__ = '2015-07-01' +# See zc.buildout's changelog if this version is up to date. + +tmpeggs = tempfile.mkdtemp(prefix='bootstrap-') + +usage = '''\ +[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] + +Bootstraps a buildout-based project. + +Simply run this script in a directory containing a buildout.cfg, using the +Python that you want bin/buildout to use. + +Note that by using --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("--version", + action="store_true", default=False, + help=("Return bootstrap.py version.")) +parser.add_option("-t", "--accept-buildout-test-releases", + dest='accept_buildout_test_releases', + action="store_true", default=False, + help=("Normally, if you do not specify a --version, the " + "bootstrap script and buildout gets the newest " + "*final* versions of zc.buildout and its recipes and " + "extensions for you. If you use this flag, " + "bootstrap and buildout will get the newest releases " + "even if they are alphas or betas.")) +parser.add_option("-c", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) +parser.add_option("--allow-site-packages", + action="store_true", default=False, + help=("Let bootstrap.py use existing site packages")) +parser.add_option("--buildout-version", + help="Use a specific zc.buildout version") +parser.add_option("--setuptools-version", + help="Use a specific setuptools version") +parser.add_option("--setuptools-to-dir", + help=("Allow for re-use of existing directory of " + "setuptools versions")) + +options, args = parser.parse_args() +if options.version: + print("bootstrap.py version %s" % __version__) + sys.exit(0) + + +###################################################################### +# load/install setuptools + +try: + from urllib.request import urlopen +except ImportError: + from urllib2 import urlopen + +ez = {} +if os.path.exists('ez_setup.py'): + exec(open('ez_setup.py').read(), ez) +else: + exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) + +if not options.allow_site_packages: + # ez_setup imports site, which adds site packages + # this will remove them from the path to ensure that incompatible versions + # of setuptools are not in the path + import site + # inside a virtualenv, there is no 'getsitepackages'. + # We can't remove these reliably + if hasattr(site, 'getsitepackages'): + for sitepackage_path in site.getsitepackages(): + # Strip all site-packages directories from sys.path that + # are not sys.prefix; this is because on Windows + # sys.prefix is a site-package directory. + if sitepackage_path != sys.prefix: + sys.path[:] = [x for x in sys.path + if sitepackage_path not in x] + +setup_args = dict(to_dir=tmpeggs, download_delay=0) + +if options.setuptools_version is not None: + setup_args['version'] = options.setuptools_version +if options.setuptools_to_dir is not None: + setup_args['to_dir'] = options.setuptools_to_dir + +ez['use_setuptools'](**setup_args) +import setuptools +import pkg_resources + +# This does not (always?) update the default working set. We will +# do it. +for path in sys.path: + if path not in pkg_resources.working_set.entries: + pkg_resources.working_set.add_entry(path) + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +# Fix sys.path here as easy_install.pth added before PYTHONPATH +cmd = [sys.executable, '-c', + 'import sys; sys.path[0:0] = [%r]; ' % setuptools_path + + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +requirement = 'zc.buildout' +version = options.buildout_version +if version is None and not options.accept_buildout_test_releases: + # Figure out the most recent final version of zc.buildout. + import setuptools.package_index + _final_parts = '*final-', '*final' + + def _final_version(parsed_version): + try: + return not parsed_version.is_prerelease + except AttributeError: + # Older setuptools + for part in parsed_version: + if (part[:1] == '*') and (part not in _final_parts): + return False + return True + + index = setuptools.package_index.PackageIndex( + search_path=[setuptools_path]) + if find_links: + index.add_find_links((find_links,)) + req = pkg_resources.Requirement.parse(requirement) + if index.obtain(req) is not None: + best = [] + bestv = None + for dist in index[req.project_name]: + distv = dist.parsed_version + if _final_version(distv): + if bestv is None or distv > bestv: + best = [dist] + bestv = distv + elif distv == bestv: + best.append(dist) + if best: + best.sort() + version = best[-1].version +if version: + requirement = '=='.join((requirement, version)) +cmd.append(requirement) + +import subprocess +if subprocess.call(cmd) != 0: + raise Exception( + "Failed to execute command:\n%s" % repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff --git a/kabot/.editorconfig b/kabot/.editorconfig new file mode 100644 index 0000000..d4a2c44 --- /dev/null +++ b/kabot/.editorconfig @@ -0,0 +1,21 @@ +# http://editorconfig.org + +root = true + +[*] +indent_style = space +indent_size = 4 +trim_trailing_whitespace = true +insert_final_newline = true +charset = utf-8 +end_of_line = lf + +[*.bat] +indent_style = tab +end_of_line = crlf + +[LICENSE] +insert_final_newline = false + +[Makefile] +indent_style = tab diff --git a/kabot/.github/ISSUE_TEMPLATE.md b/kabot/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..beadd37 --- /dev/null +++ b/kabot/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +* Kabot version: +* Python version: +* Operating System: + +### Description + +Describe what you were trying to get done. +Tell us what happened, what went wrong, and what you expected to happen. + +### What I Did + +``` +Paste the command(s) you ran and the output. +If there was a crash, please include the traceback here. +``` diff --git a/kabot/.gitignore b/kabot/.gitignore new file mode 100644 index 0000000..84229f4 --- /dev/null +++ b/kabot/.gitignore @@ -0,0 +1,102 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# dotenv +.env + +# virtualenv +.venv +venv/ +ENV/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ diff --git a/kabot/.travis.yml b/kabot/.travis.yml new file mode 100644 index 0000000..eac3d8b --- /dev/null +++ b/kabot/.travis.yml @@ -0,0 +1,16 @@ +# Config file for automatic testing at travis-ci.org + +language: python +python: + - 3.7 + - 3.6 + - 3.5 + - 2.7 + +# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors +install: pip install -U tox-travis + +# Command to run tests, e.g. python setup.py test +script: tox + + diff --git a/kabot/AUTHORS.rst b/kabot/AUTHORS.rst new file mode 100644 index 0000000..950afc9 --- /dev/null +++ b/kabot/AUTHORS.rst @@ -0,0 +1,13 @@ +======= +Credits +======= + +Development Lead +---------------- + +* Michaël Ricart + +Contributors +------------ + +None yet. Why not be the first? diff --git a/kabot/CONTRIBUTING.rst b/kabot/CONTRIBUTING.rst new file mode 100644 index 0000000..00cf557 --- /dev/null +++ b/kabot/CONTRIBUTING.rst @@ -0,0 +1,128 @@ +.. highlight:: shell + +============ +Contributing +============ + +Contributions are welcome, and they are greatly appreciated! Every little bit +helps, and credit will always be given. + +You can contribute in many ways: + +Types of Contributions +---------------------- + +Report Bugs +~~~~~~~~~~~ + +Report bugs at https://github.com/None/kabot/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +Fix Bugs +~~~~~~~~ + +Look through the GitHub issues for bugs. Anything tagged with "bug" and "help +wanted" is open to whoever wants to implement it. + +Implement Features +~~~~~~~~~~~~~~~~~~ + +Look through the GitHub issues for features. Anything tagged with "enhancement" +and "help wanted" is open to whoever wants to implement it. + +Write Documentation +~~~~~~~~~~~~~~~~~~~ + +Kabot could always use more documentation, whether as part of the +official Kabot docs, in docstrings, or even on the web in blog posts, +articles, and such. + +Submit Feedback +~~~~~~~~~~~~~~~ + +The best way to send feedback is to file an issue at https://github.com/None/kabot/issues. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. +* Remember that this is a volunteer-driven project, and that contributions + are welcome :) + +Get Started! +------------ + +Ready to contribute? Here's how to set up `kabot` for local development. + +1. Fork the `kabot` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/kabot.git + +3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: + + $ mkvirtualenv kabot + $ cd kabot/ + $ python setup.py develop + +4. Create a branch for local development:: + + $ git checkout -b name-of-your-bugfix-or-feature + + Now you can make your changes locally. + +5. When you're done making changes, check that your changes pass flake8 and the + tests, including testing other Python versions with tox:: + + $ flake8 kabot tests + $ python setup.py test or pytest + $ tox + + To get flake8 and tox, just pip install them into your virtualenv. + +6. Commit your changes and push your branch to GitHub:: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +7. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. Put + your new functionality into a function with a docstring, and add the + feature to the list in README.rst. +3. The pull request should work for Python 2.7, 3.5, 3.6 and 3.7, and for PyPy. Check + https://travis-ci.org/None/kabot/pull_requests + and make sure that the tests pass for all supported Python versions. + +Tips +---- + +To run a subset of tests:: + + + $ python -m unittest tests.test_kabot + +Deploying +--------- + +A reminder for the maintainers on how to deploy. +Make sure all your changes are committed (including an entry in HISTORY.rst). +Then run:: + +$ bump2version patch # possible: major / minor / patch +$ git push +$ git push --tags + +Travis will then deploy to PyPI if tests pass. diff --git a/kabot/HISTORY.rst b/kabot/HISTORY.rst new file mode 100644 index 0000000..c67f1d4 --- /dev/null +++ b/kabot/HISTORY.rst @@ -0,0 +1,8 @@ +======= +History +======= + +0.1.0 (2019-09-27) +------------------ + +* First release on PyPI. diff --git a/kabot/LICENSE b/kabot/LICENSE new file mode 100644 index 0000000..80c15e7 --- /dev/null +++ b/kabot/LICENSE @@ -0,0 +1,32 @@ + + +BSD License + +Copyright (c) 2019, Michaël Ricart +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, this + list of conditions and the following disclaimer in the documentation and/or + other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from this + software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/kabot/MANIFEST.in b/kabot/MANIFEST.in new file mode 100644 index 0000000..965b2dd --- /dev/null +++ b/kabot/MANIFEST.in @@ -0,0 +1,11 @@ +include AUTHORS.rst +include CONTRIBUTING.rst +include HISTORY.rst +include LICENSE +include README.rst + +recursive-include tests * +recursive-exclude * __pycache__ +recursive-exclude * *.py[co] + +recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif diff --git a/kabot/Makefile b/kabot/Makefile new file mode 100644 index 0000000..f65d86a --- /dev/null +++ b/kabot/Makefile @@ -0,0 +1,88 @@ +.PHONY: clean clean-test clean-pyc clean-build docs help +.DEFAULT_GOAL := help + +define BROWSER_PYSCRIPT +import os, webbrowser, sys + +try: + from urllib import pathname2url +except: + from urllib.request import pathname2url + +webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1]))) +endef +export BROWSER_PYSCRIPT + +define PRINT_HELP_PYSCRIPT +import re, sys + +for line in sys.stdin: + match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line) + if match: + target, help = match.groups() + print("%-20s %s" % (target, help)) +endef +export PRINT_HELP_PYSCRIPT + +BROWSER := python -c "$$BROWSER_PYSCRIPT" + +help: + @python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) + +clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts + +clean-build: ## remove build artifacts + rm -fr build/ + rm -fr dist/ + rm -fr .eggs/ + find . -name '*.egg-info' -exec rm -fr {} + + find . -name '*.egg' -exec rm -f {} + + +clean-pyc: ## remove Python file artifacts + find . -name '*.pyc' -exec rm -f {} + + find . -name '*.pyo' -exec rm -f {} + + find . -name '*~' -exec rm -f {} + + find . -name '__pycache__' -exec rm -fr {} + + +clean-test: ## remove test and coverage artifacts + rm -fr .tox/ + rm -f .coverage + rm -fr htmlcov/ + rm -fr .pytest_cache + +lint: ## check style with flake8 + flake8 kabot tests + +test: ## run tests quickly with the default Python + python setup.py test + +test-all: ## run tests on every Python version with tox + tox + +coverage: ## check code coverage quickly with the default Python + coverage run --source kabot setup.py test + coverage report -m + coverage html + $(BROWSER) htmlcov/index.html + +docs: ## generate Sphinx HTML documentation, including API docs + rm -f docs/kabot.rst + rm -f docs/modules.rst + sphinx-apidoc -o docs/ kabot + $(MAKE) -C docs clean + $(MAKE) -C docs html + $(BROWSER) docs/_build/html/index.html + +servedocs: docs ## compile the docs watching for changes + watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D . + +release: dist ## package and upload a release + twine upload dist/* + +dist: clean ## builds source and wheel package + python setup.py sdist + python setup.py bdist_wheel + ls -l dist + +install: clean ## install the package to the active Python's site-packages + python setup.py install diff --git a/kabot/README.rst b/kabot/README.rst new file mode 100644 index 0000000..7616ab4 --- /dev/null +++ b/kabot/README.rst @@ -0,0 +1,37 @@ +===== +Kabot +===== + + +.. image:: https://img.shields.io/pypi/v/kabot.svg + :target: https://pypi.python.org/pypi/kabot + +.. image:: https://img.shields.io/travis/None/kabot.svg + :target: https://travis-ci.org/None/kabot + +.. image:: https://readthedocs.org/projects/kabot/badge/?version=latest + :target: https://kabot.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + + + + +kabot for discord + + +* Free software: BSD license +* Documentation: https://kabot.readthedocs.io. + + +Features +-------- + +* TODO + +Credits +------- + +This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. + +.. _Cookiecutter: https://github.com/audreyr/cookiecutter +.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage diff --git a/kabot/docs/Makefile b/kabot/docs/Makefile new file mode 100644 index 0000000..cc4218b --- /dev/null +++ b/kabot/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = python -msphinx +SPHINXPROJ = kabot +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/kabot/docs/authors.rst b/kabot/docs/authors.rst new file mode 100644 index 0000000..e122f91 --- /dev/null +++ b/kabot/docs/authors.rst @@ -0,0 +1 @@ +.. include:: ../AUTHORS.rst diff --git a/kabot/docs/conf.py b/kabot/docs/conf.py new file mode 100755 index 0000000..0dcec1b --- /dev/null +++ b/kabot/docs/conf.py @@ -0,0 +1,163 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# kabot documentation build configuration file, created by +# sphinx-quickstart on Fri Jun 9 13:47:02 2017. +# +# 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. + +# 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. +# +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +import kabot + +# -- General configuration --------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Kabot' +copyright = u"2019, Michaël Ricart" +author = u"Michaël Ricart" + +# 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 = kabot.__version__ +# The full version, including alpha/beta/rc tags. +release = kabot.__version__ + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 = 'alabaster' + +# 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 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'] + + +# -- Options for HTMLHelp output --------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'kabotdoc' + + +# -- 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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# 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 = [ + (master_doc, 'kabot.tex', + u'Kabot Documentation', + u'Michaël Ricart', 'manual'), +] + + +# -- Options for manual page output ------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'kabot', + u'Kabot Documentation', + [author], 1) +] + + +# -- 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 = [ + (master_doc, 'kabot', + u'Kabot Documentation', + author, + 'kabot', + 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/kabot/docs/contributing.rst b/kabot/docs/contributing.rst new file mode 100644 index 0000000..e582053 --- /dev/null +++ b/kabot/docs/contributing.rst @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTING.rst diff --git a/kabot/docs/history.rst b/kabot/docs/history.rst new file mode 100644 index 0000000..2506499 --- /dev/null +++ b/kabot/docs/history.rst @@ -0,0 +1 @@ +.. include:: ../HISTORY.rst diff --git a/kabot/docs/index.rst b/kabot/docs/index.rst new file mode 100644 index 0000000..b6ff17b --- /dev/null +++ b/kabot/docs/index.rst @@ -0,0 +1,20 @@ +Welcome to Kabot's documentation! +====================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + readme + installation + usage + modules + contributing + authors + history + +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/kabot/docs/installation.rst b/kabot/docs/installation.rst new file mode 100644 index 0000000..4d93395 --- /dev/null +++ b/kabot/docs/installation.rst @@ -0,0 +1,51 @@ +.. highlight:: shell + +============ +Installation +============ + + +Stable release +-------------- + +To install Kabot, run this command in your terminal: + +.. code-block:: console + + $ pip install kabot + +This is the preferred method to install Kabot, as it will always install the most recent stable release. + +If you don't have `pip`_ installed, this `Python installation guide`_ can guide +you through the process. + +.. _pip: https://pip.pypa.io +.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ + + +From sources +------------ + +The sources for Kabot can be downloaded from the `Github repo`_. + +You can either clone the public repository: + +.. code-block:: console + + $ git clone git://github.com/None/kabot + +Or download the `tarball`_: + +.. code-block:: console + + $ curl -OJL https://github.com/None/kabot/tarball/master + +Once you have a copy of the source, you can install it with: + +.. code-block:: console + + $ python setup.py install + + +.. _Github repo: https://github.com/None/kabot +.. _tarball: https://github.com/None/kabot/tarball/master diff --git a/kabot/docs/make.bat b/kabot/docs/make.bat new file mode 100644 index 0000000..a80bc40 --- /dev/null +++ b/kabot/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=python -msphinx +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=kabot + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/kabot/docs/readme.rst b/kabot/docs/readme.rst new file mode 100644 index 0000000..72a3355 --- /dev/null +++ b/kabot/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/kabot/docs/usage.rst b/kabot/docs/usage.rst new file mode 100644 index 0000000..13fefb2 --- /dev/null +++ b/kabot/docs/usage.rst @@ -0,0 +1,7 @@ +===== +Usage +===== + +To use Kabot in a project:: + + import kabot diff --git a/kabot/kabot/__init__.py b/kabot/kabot/__init__.py new file mode 100644 index 0000000..3afb091 --- /dev/null +++ b/kabot/kabot/__init__.py @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- + +"""Top-level package for Kabot.""" + +__author__ = """Michaël Ricart""" +__email__ = 'michael.ricart@0w.tf' +__version__ = '0.1.0' diff --git a/kabot/kabot/cli.py b/kabot/kabot/cli.py new file mode 100644 index 0000000..b6a769d --- /dev/null +++ b/kabot/kabot/cli.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- + +"""Console script for kabot.""" +import argparse +import sys +from .kabot import * + +def main(): + """Console script for kabot.""" + parser = argparse.ArgumentParser() + parser.add_argument('_', nargs='*') + args = parser.parse_args() + + print("Arguments: " + str(args._)) + print("Replace this message by putting your code into " + "kabot.cli.main") + return 0 + + +if __name__ == "__main__": + launch() + sys.exit(main()) # pragma: no cover diff --git a/kabot/kabot/kabot.py b/kabot/kabot/kabot.py new file mode 100644 index 0000000..27a0446 --- /dev/null +++ b/kabot/kabot/kabot.py @@ -0,0 +1,40 @@ +# -*- coding: utf-8 -*- + +"""Main module.""" +import random + +import discord +from discord.ext import commands + +def main(): + client = discord.Client() + token = "NjI3MTM3NDY1MDA5ODMxOTQ2.XY4Raw.pw8sAen3bNR5aYsoTChQOudM0L8" + + bot = commands.Bot(command_prefix='!') + + @bot.command(name='test', help='Responds with a random quote') + async def nine_nine(ctx): + quotes = [ + "Pour savoir s’y a du vent, il faut mettre son doigt dans le cul du coq.", + "Y'a des méchants ?", + "À Kabot ! À Kabot !", + "Tatan, elle fait des flans.", + "Les pattes de canaaaaaaaaaaaaaaaaaaaaaaaaaaaaard !", + "Elle est où la poulette ?", + "Mooordu! Mooordu! Mordu mordu mordu mordu la ligne !!!!", + ] + + response = random.choice(quotes) + await ctx.send(response) + + @client.event + async def on_ready(): + print(f'{client.user.name} has connected to Discord!') + + @client.event + async def on_message(message): + print(message.content) + if message.author == client.user: + return + + bot.run(token) diff --git a/kabot/requirements_dev.txt b/kabot/requirements_dev.txt new file mode 100644 index 0000000..c54c8ce --- /dev/null +++ b/kabot/requirements_dev.txt @@ -0,0 +1,10 @@ +pip==19.2.3 +bump2version==0.5.11 +wheel==0.33.6 +watchdog==0.9.0 +flake8==3.7.8 +tox==3.14.0 +coverage==4.5.4 +Sphinx==1.8.5 +twine==1.14.0 + diff --git a/kabot/setup.cfg b/kabot/setup.cfg new file mode 100644 index 0000000..f69a881 --- /dev/null +++ b/kabot/setup.cfg @@ -0,0 +1,22 @@ +[bumpversion] +current_version = 0.1.0 +commit = True +tag = True + +[bumpversion:file:setup.py] +search = version='{current_version}' +replace = version='{new_version}' + +[bumpversion:file:kabot/__init__.py] +search = __version__ = '{current_version}' +replace = __version__ = '{new_version}' + +[bdist_wheel] +universal = 1 + +[flake8] +exclude = docs + +[aliases] +# Define setup.py command aliases here + diff --git a/kabot/setup.py b/kabot/setup.py new file mode 100644 index 0000000..71625db --- /dev/null +++ b/kabot/setup.py @@ -0,0 +1,55 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +"""The setup script.""" + +from setuptools import setup, find_packages + +with open('README.rst') as readme_file: + readme = readme_file.read() + +with open('HISTORY.rst') as history_file: + history = history_file.read() + +requirements = ['discord.py' ] + +setup_requirements = [ ] + +test_requirements = [ ] + +setup( + author="Michaël Ricart", + author_email='michael.ricart@0w.tf', + python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: BSD License', + 'Natural Language :: English', + "Programming Language :: Python :: 2", + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + ], + description="kabot for discord", + entry_points={ + 'console_scripts': [ + 'kabot=kabot.kabot:main', + ], + }, + install_requires=requirements, + license="BSD license", + long_description=readme + '\n\n' + history, + include_package_data=True, + keywords='kabot', + name='kabot', + packages=find_packages(include=['kabot', 'kabot.*']), + setup_requires=setup_requirements, + test_suite='tests', + tests_require=test_requirements, + url='https://github.com/None/kabot', + version='0.1.0', + zip_safe=False, +) diff --git a/kabot/tests/__init__.py b/kabot/tests/__init__.py new file mode 100644 index 0000000..4d9cd8a --- /dev/null +++ b/kabot/tests/__init__.py @@ -0,0 +1,3 @@ +# -*- coding: utf-8 -*- + +"""Unit test package for kabot.""" diff --git a/kabot/tests/test_kabot.py b/kabot/tests/test_kabot.py new file mode 100644 index 0000000..854ef3e --- /dev/null +++ b/kabot/tests/test_kabot.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +"""Tests for `kabot` package.""" + + +import unittest + +from kabot import kabot + + +class TestKabot(unittest.TestCase): + """Tests for `kabot` package.""" + + def setUp(self): + """Set up test fixtures, if any.""" + + def tearDown(self): + """Tear down test fixtures, if any.""" + + def test_000_something(self): + """Test something.""" diff --git a/kabot/tox.ini b/kabot/tox.ini new file mode 100644 index 0000000..e9b5d39 --- /dev/null +++ b/kabot/tox.ini @@ -0,0 +1,20 @@ +[tox] +envlist = py27, py35, py36, py37 flake8 + +[travis] +python = + 3.7: py37 + 3.6: py36 + 3.5: py35 + 2.7: py27 + +[testenv:flake8] +basepython = python +deps = flake8 +commands = flake8 kabot + +[testenv] +setenv = + PYTHONPATH = {toxinidir} + +commands = python setup.py test diff --git a/pinned.cfg b/pinned.cfg new file mode 100644 index 0000000..c712515 --- /dev/null +++ b/pinned.cfg @@ -0,0 +1,37 @@ +[versions] +Click = 7.0 +Jinja2 = 2.10.1 +MarkupSafe = 1.1.1 +aiohttp = 3.5.4 +async-timeout = 3.0.1 +attrs = 19.1.0 +binaryornot = 0.4.4 +certifi = 2019.9.11 +chardet = 3.0.4 +cookiecutter = 1.6.0 +future = 0.17.1 +idna = 2.8 +jinja2-time = 0.2.0 +mr.developer = 2.0.0 +multidict = 4.5.2 +poyo = 0.5.0 +requests = 2.22.0 +urllib3 = 1.25.6 +websockets = 6.0 +whichcraft = 0.6.1 +yarl = 1.3.0 +zc.buildout = 2.13.2 +zc.recipe.egg = 2.0.7 + +# Required by: +# jinja2-time==0.2.0 +arrow = 0.15.2 + +# Required by: +# arrow==0.15.2 +python-dateutil = 2.8.0 + +# Required by: +# mr.developer==2.0.0 +six = 1.12.0 +