Jonathan Golder
6 years ago
9 changed files with 250 additions and 5 deletions
@ -0,0 +1,8 @@ |
|||||
|
# Include the README |
||||
|
include *.md |
||||
|
|
||||
|
# Include the license file |
||||
|
include LICENSE.txt |
||||
|
|
||||
|
# Include the data files |
||||
|
# recursive-include data * |
@ -1,22 +1,30 @@ |
|||||
# wiki-jogobot-core |
# jogobot |
||||
This python module contains code shared between several [Pywikibot](https://www.mediawiki.org/wiki/Manual:Pywikibot) |
This python module contains code shared between several [Pywikibot](https://www.mediawiki.org/wiki/Manual:Pywikibot) |
||||
based projects of [User:JogoBot](https://de.wikipedia.org/wiki/Benutzer:JogoBot) on the |
based projects of [User:JogoBot](https://de.wikipedia.org/wiki/Benutzer:JogoBot) on the |
||||
[German Wikipedia](https://de.wikipedia.org/wiki/Wikipedia:Hauptseite). |
[German Wikipedia](https://de.wikipedia.org/wiki/Wikipedia:Hauptseite). |
||||
|
|
||||
## Requirements |
## Requirements |
||||
* Python 3.4+ (at least it is only tested with those) |
* Python 3.4+ (at least it is only tested with those) |
||||
* pywikibot-core 2.0 |
* pywikibot-core 2.0+ ([Installation HowTo](https://www.mediawiki.org/wiki/Manual:Pywikibot/Installation)) |
||||
|
|
||||
|
## Installation |
||||
|
```shell |
||||
|
pip install git+https://git.golderweb.de/wiki/jogobot.git@v0.2#egg=jogobot |
||||
|
``` |
||||
|
|
||||
## Bugs |
## Bugs |
||||
[wiki-jogobot-core on fs.golderweb.de (de)](https://fs.golderweb.de/proj22) |
[jogobot Issues](https://git.golderweb.de/wiki/jogobot/issues) |
||||
|
|
||||
## Version |
## Versions |
||||
|
|
||||
* 0.1 |
* 0.1 |
||||
- first stable release |
- first stable release |
||||
|
|
||||
|
* 0.2 |
||||
|
- package installable via setuptools/pip |
||||
|
|
||||
## License |
## License |
||||
GPLv3+ |
GPLv3+ |
||||
|
|
||||
## Author Information |
## Author Information |
||||
Copyright 2017 Jonathan Golder <jonathan@golderweb.de> |
Copyright 2018 Jonathan Golder <jonathan@golderweb.de> |
||||
|
@ -0,0 +1,12 @@ |
|||||
|
[metadata] |
||||
|
# This includes the license file in the wheel. |
||||
|
license_file = LICENSE.txt |
||||
|
|
||||
|
[bdist_wheel] |
||||
|
# This flag says to generate wheels that support both Python 2 and Python |
||||
|
# 3. If your code will not run unchanged on both Python 2 and 3, you will |
||||
|
# need to generate separate wheels for each Python version that you |
||||
|
# support. Removing this line (or setting universal to 0) will prevent |
||||
|
# bdist_wheel from trying to make a universal wheel. For more see: |
||||
|
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#wheels |
||||
|
# universal=1 |
@ -0,0 +1,217 @@ |
|||||
|
#!/usr/bin/env python3 |
||||
|
# setup.py |
||||
|
# |
||||
|
# Copyright 2018 Jonathan Golder <jonathan@golderweb.de> |
||||
|
# |
||||
|
# 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 2 of the License, or |
||||
|
# (at your option) 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, write to the Free Software |
||||
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
||||
|
# MA 02110-1301, USA. |
||||
|
# |
||||
|
# |
||||
|
|
||||
|
""" |
||||
|
JogoBot |
||||
|
|
||||
|
This python module contains code shared between several [Pywikibot](https://www.mediawiki.org/wiki/Manual:Pywikibot) |
||||
|
based projects of [User:JogoBot](https://de.wikipedia.org/wiki/Benutzer:JogoBot) on the |
||||
|
[German Wikipedia](https://de.wikipedia.org/wiki/Wikipedia:Hauptseite). |
||||
|
""" |
||||
|
|
||||
|
# Always prefer setuptools over distutils |
||||
|
from setuptools import setup, find_packages |
||||
|
from os import path |
||||
|
# io.open is needed for projects that support Python 2.7 |
||||
|
# It ensures open() defaults to text mode with universal newlines, |
||||
|
# and accepts an argument to specify the text encoding |
||||
|
# Python 3 only projects can skip this import |
||||
|
from io import open |
||||
|
|
||||
|
here = path.abspath(path.dirname(__file__)) |
||||
|
|
||||
|
# Get the long description from the README file |
||||
|
with open(path.join(here, 'README.md'), encoding='utf-8') as f: |
||||
|
long_description = f.read() |
||||
|
|
||||
|
# Arguments marked as "Required" below must be included for upload to PyPI. |
||||
|
# Fields marked as "Optional" may be commented out. |
||||
|
|
||||
|
setup( |
||||
|
# This is the name of your project. The first time you publish this |
||||
|
# package, this name will be registered for you. It will determine how |
||||
|
# users can install this project, e.g.: |
||||
|
# |
||||
|
# $ pip install sampleproject |
||||
|
# |
||||
|
# And where it will live on PyPI: https://pypi.org/project/sampleproject/ |
||||
|
# |
||||
|
# There are some restrictions on what makes a valid project name |
||||
|
# specification here: |
||||
|
# https://packaging.python.org/specifications/core-metadata/#name |
||||
|
name='jogobot', # Required |
||||
|
|
||||
|
# Versions should comply with PEP 440: |
||||
|
# https://www.python.org/dev/peps/pep-0440/ |
||||
|
# |
||||
|
# For a discussion on single-sourcing the version across setup.py and the |
||||
|
# project code, see |
||||
|
# https://packaging.python.org/en/latest/single_source_version.html |
||||
|
version='0.2', # Required |
||||
|
|
||||
|
# This is a one-line description or tagline of what your project does. This |
||||
|
# corresponds to the "Summary" metadata field: |
||||
|
# https://packaging.python.org/specifications/core-metadata/#summary |
||||
|
description='Shared code for jogobot', # Optional |
||||
|
|
||||
|
# This is an optional longer description of your project that represents |
||||
|
# the body of text which users will see when they visit PyPI. |
||||
|
# |
||||
|
# Often, this is the same as your README, so you can just read it in from |
||||
|
# that file directly (as we have already done above) |
||||
|
# |
||||
|
# This field corresponds to the "Description" metadata field: |
||||
|
# https://packaging.python.org/specifications/core-metadata/#description-optional |
||||
|
long_description=long_description, # Optional |
||||
|
|
||||
|
# Denotes that our long_description is in Markdown; valid values are |
||||
|
# text/plain, text/x-rst, and text/markdown |
||||
|
# |
||||
|
# Optional if long_description is written in reStructuredText (rst) but |
||||
|
# required for plain-text or Markdown; if unspecified, "applications should |
||||
|
# attempt to render [the long_description] as text/x-rst; charset=UTF-8 and |
||||
|
# fall back to text/plain if it is not valid rst" (see link below) |
||||
|
# |
||||
|
# This field corresponds to the "Description-Content-Type" metadata field: |
||||
|
# https://packaging.python.org/specifications/core-metadata/#description-content-type-optional |
||||
|
long_description_content_type='text/markdown', # Optional (see note above) |
||||
|
|
||||
|
# This should be a valid link to your project's main homepage. |
||||
|
# |
||||
|
# This field corresponds to the "Home-Page" metadata field: |
||||
|
# https://packaging.python.org/specifications/core-metadata/#home-page-optional |
||||
|
url='https://git.golderweb.de/wiki/jogobot', # Optional |
||||
|
|
||||
|
# This should be your name or the name of the organization which owns the |
||||
|
# project. |
||||
|
author='Jonathan Golder', # Optional |
||||
|
|
||||
|
# This should be a valid email address corresponding to the author listed |
||||
|
# above. |
||||
|
author_email='jonathan@golderweb.de', # Optional |
||||
|
|
||||
|
# Classifiers help users find your project by categorizing it. |
||||
|
# |
||||
|
# For a list of valid classifiers, see https://pypi.org/classifiers/ |
||||
|
classifiers=[ # Optional |
||||
|
# How mature is this project? Common values are |
||||
|
# 3 - Alpha |
||||
|
# 4 - Beta |
||||
|
# 5 - Production/Stable |
||||
|
'Development Status :: 4 - Beta', |
||||
|
|
||||
|
# Indicate who your project is intended for |
||||
|
'Intended Audience :: Developers', |
||||
|
'Topic :: Software Development :: Libraries :: Python Module', |
||||
|
|
||||
|
# Pick your license as you wish |
||||
|
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', |
||||
|
|
||||
|
# Specify the Python versions you support here. In particular, ensure |
||||
|
# that you indicate whether you support Python 2, Python 3 or both. |
||||
|
'Programming Language :: Python :: 3', |
||||
|
'Programming Language :: Python :: 3.4', |
||||
|
'Programming Language :: Python :: 3.5', |
||||
|
'Programming Language :: Python :: 3.6', |
||||
|
'Programming Language :: Python :: 3.7' |
||||
|
], |
||||
|
|
||||
|
# This field adds keywords for your project which will appear on the |
||||
|
# project page. What does your project relate to? |
||||
|
# |
||||
|
# Note that this is a string of words separated by whitespace, not a list. |
||||
|
keywords='jogobot pywikibot wikimedia', # Optional |
||||
|
|
||||
|
# You can just specify package directories manually here if your project is |
||||
|
# simple. Or you can use find_packages(). |
||||
|
# |
||||
|
# Alternatively, if you just want to distribute a single Python file, use |
||||
|
# the `py_modules` argument instead as follows, which will expect a file |
||||
|
# called `my_module.py` to exist: |
||||
|
# |
||||
|
# py_modules=["my_module"], |
||||
|
# |
||||
|
packages=find_packages(exclude=['contrib', 'docs', 'tests']), # Required |
||||
|
|
||||
|
# This field lists other packages that your project depends on to run. |
||||
|
# Any package you put here will be installed by pip when your project is |
||||
|
# installed, so they must be valid existing projects. |
||||
|
# |
||||
|
# For an analysis of "install_requires" vs pip's requirements files see: |
||||
|
# https://packaging.python.org/en/latest/requirements.html |
||||
|
install_requires=[], # Optional |
||||
|
|
||||
|
# List additional groups of dependencies here (e.g. development |
||||
|
# dependencies). Users will be able to install these using the "extras" |
||||
|
# syntax, for example: |
||||
|
# |
||||
|
# $ pip install sampleproject[dev] |
||||
|
# |
||||
|
# Similar to `install_requires` above, these must be valid existing |
||||
|
# projects. |
||||
|
extras_require={ # Optional |
||||
|
'dev': [], |
||||
|
'test': [], |
||||
|
}, |
||||
|
|
||||
|
# Set required python version |
||||
|
python_requires='>=3', |
||||
|
|
||||
|
# If there are data files included in your packages that need to be |
||||
|
# installed, specify them here. |
||||
|
# |
||||
|
# If using Python 2.6 or earlier, then these have to be included in |
||||
|
# MANIFEST.in as well. |
||||
|
package_data={ # Optional |
||||
|
}, |
||||
|
|
||||
|
# Although 'package_data' is the preferred approach, in some case you may |
||||
|
# need to place data files outside of your packages. See: |
||||
|
# http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files |
||||
|
# |
||||
|
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data' |
||||
|
data_files=[], # Optional |
||||
|
|
||||
|
# To provide executable scripts, use entry points in preference to the |
||||
|
# "scripts" keyword. Entry points provide cross-platform support and allow |
||||
|
# `pip` to create the appropriate form of executable for the target |
||||
|
# platform. |
||||
|
# |
||||
|
# For example, the following would provide a command called `sample` which |
||||
|
# executes the function `main` from this package when invoked: |
||||
|
entry_points={ # Optional |
||||
|
}, |
||||
|
|
||||
|
# List additional URLs that are relevant to your project as a dict. |
||||
|
# |
||||
|
# This field corresponds to the "Project-URL" metadata fields: |
||||
|
# https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use |
||||
|
# |
||||
|
# Examples listed include a pattern for specifying where the package tracks |
||||
|
# issues, where the source is hosted, where to say thanks to the package |
||||
|
# maintainers, and where to support the project financially. The key is |
||||
|
# what's used to render the link text on PyPI. |
||||
|
project_urls={ # Optional |
||||
|
'Bug Reports': 'https://git.golderweb.de/wiki/jogobot/issues', |
||||
|
'Source': 'https://git.golderweb.de/wiki/jogobot', |
||||
|
}, |
||||
|
) |
Loading…
Reference in new issue