[MediaWiki-commits] [Gerrit] pywikibot/core[master]: Update pypi description

2017-08-06 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/365268 )

Change subject: Update pypi description
..


Update pypi description

README.rst does not contain a valid desciption for pypi because it also
contains root files and scripts but these files aren't shipped with the
pypi package. Use a new file "pypi_description.rst" for it.

Change-Id: I1b536ef30ce772124e0ae52472e5848b0e28867b
---
A pypi_description.rst
M setup.py
2 files changed, 90 insertions(+), 1 deletion(-)

Approvals:
  Merlijn van Deen: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/pypi_description.rst b/pypi_description.rst
new file mode 100644
index 000..25af392
--- /dev/null
+++ b/pypi_description.rst
@@ -0,0 +1,89 @@
+Pywikibot
+=
+
+The Pywikibot framework is a Python library that interfaces with the
+`MediaWiki API 
`_
+version 1.14 or higher.
+
+Also included are various general function scripts that can be adapted for
+different tasks.
+
+For further information about the library excluding scripts see
+the full `code documentation `_.
+
+Quick start
+---
+
+::
+
+git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
+cd core
+git submodule update --init
+python pwb.py script_name
+
+Or to install using PyPI (excluding scripts)
+::
+
+pip install pywikibot --pre
+
+Our `installation
+guide 
`_
+has more details for advanced usage.
+
+Basic Usage
+---
+
+If you wish to write your own script it's very easy to get started:
+
+::
+
+import pywikibot
+site = pywikibot.Site('en', 'wikipedia')  # The site we want to run our 
bot on
+page = pywikibot.Page(site, 'Wikipedia:Sandbox')
+page.text = page.text.replace('foo', 'bar')
+page.save('Replacing "foo" with "bar"')  # Saves the page
+
+---
+
+For more documentation on pywikibot see our `docs 
`_.
+
+
+The contents of the package
+
+
+
+--+
+|  Directories 
|
+
+===+==+
+|  pywikibot| Library routines, control files and global 
settings  |
+
+---+--+
+|  pywikibot/comms  | Communication layer  
|
+
+---+--+
+|  pywikibot/compat | Package to provide compatibility with compat 
scripts |
+
+---+--+
+|  pywikibot/data   | Module with several layers for data access 
to wiki   |
+
+---+--+
+|  pywikibot/families   | wiki-specific information and settings   
|
+
+---+--+
+|  pywikibot/tools  | Miscellaneous helper functions (not 
wiki-dependent)  |
+
+---+--+
+|  pywikibot/userinterfaces | GUI and terminal interface   
|
+
+---+--+
+
+
+Required external programs
+---
+
+It may require the following programs to function properly:
+
+* `7za`: To extract 7z files
+
+Contributing
+
+
+Our code is maintained on Wikimedia's `Gerrit installation 
`_,
+`learn `_ 
how to get
+started.
+
+.. image:: 
https://secure.travis-ci.org/wikimedia/pywikibot-core.png?branch=master
+   :alt: Build Status
+   :target: https://travis-ci.org/wikimedia/pywikibot-core
diff --git a/setup.py b/setup.py
index 015a817..d78a7e2 100644
--- a/setup.py
+++ b/setup.py
@@ -208,7 +208,7 @@
 name=name,
 version=version,
 description='Python MediaWiki Bot Framework',
-long_description=open('README.rst').read(),
+long_description=open('pypi_description.rst').read(),
 keywords=('pywikibot', 'python', 'mediawiki', 'bot', 'wiki', 'framework',
   'wikimedia', 'wikipedia', 'pwb', 'pywikipedia', 'API'),
 maintainer='The Pywikibot team',

-- 
To view, visit https://gerrit.wikimedia.org/r/365268
To unsubscribe,

[MediaWiki-commits] [Gerrit] pywikibot/core[master]: Update pypi description

2017-07-14 Thread Xqt (Code Review) 
Xqt has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/365268 )

Change subject: Update pypi description
..

Update pypi description

README.rst does not contain a valid desciption fpr pypi because it also
contains root files and scripts but these files aren't shipped with the
pypi package. Use a new file "pypi_description.rst" for it.

Change-Id: I1b536ef30ce772124e0ae52472e5848b0e28867b
---
A pypi_description.rst
M setup.py
2 files changed, 90 insertions(+), 1 deletion(-)


  git pull ssh://gerrit.wikimedia.org:29418/pywikibot/core 
refs/changes/68/365268/1

diff --git a/pypi_description.rst b/pypi_description.rst
new file mode 100644
index 000..25af392
--- /dev/null
+++ b/pypi_description.rst
@@ -0,0 +1,89 @@
+Pywikibot
+=
+
+The Pywikibot framework is a Python library that interfaces with the
+`MediaWiki API 
`_
+version 1.14 or higher.
+
+Also included are various general function scripts that can be adapted for
+different tasks.
+
+For further information about the library excluding scripts see
+the full `code documentation `_.
+
+Quick start
+---
+
+::
+
+git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
+cd core
+git submodule update --init
+python pwb.py script_name
+
+Or to install using PyPI (excluding scripts)
+::
+
+pip install pywikibot --pre
+
+Our `installation
+guide 
`_
+has more details for advanced usage.
+
+Basic Usage
+---
+
+If you wish to write your own script it's very easy to get started:
+
+::
+
+import pywikibot
+site = pywikibot.Site('en', 'wikipedia')  # The site we want to run our 
bot on
+page = pywikibot.Page(site, 'Wikipedia:Sandbox')
+page.text = page.text.replace('foo', 'bar')
+page.save('Replacing "foo" with "bar"')  # Saves the page
+
+---
+
+For more documentation on pywikibot see our `docs 
`_.
+
+
+The contents of the package
+
+
+
+--+
+|  Directories 
|
+
+===+==+
+|  pywikibot| Library routines, control files and global 
settings  |
+
+---+--+
+|  pywikibot/comms  | Communication layer  
|
+
+---+--+
+|  pywikibot/compat | Package to provide compatibility with compat 
scripts |
+
+---+--+
+|  pywikibot/data   | Module with several layers for data access 
to wiki   |
+
+---+--+
+|  pywikibot/families   | wiki-specific information and settings   
|
+
+---+--+
+|  pywikibot/tools  | Miscellaneous helper functions (not 
wiki-dependent)  |
+
+---+--+
+|  pywikibot/userinterfaces | GUI and terminal interface   
|
+
+---+--+
+
+
+Required external programs
+---
+
+It may require the following programs to function properly:
+
+* `7za`: To extract 7z files
+
+Contributing
+
+
+Our code is maintained on Wikimedia's `Gerrit installation 
`_,
+`learn `_ 
how to get
+started.
+
+.. image:: 
https://secure.travis-ci.org/wikimedia/pywikibot-core.png?branch=master
+   :alt: Build Status
+   :target: https://travis-ci.org/wikimedia/pywikibot-core
diff --git a/setup.py b/setup.py
index cb74bca..169c28a 100644
--- a/setup.py
+++ b/setup.py
@@ -208,7 +208,7 @@
 name=name,
 version=version,
 description='Python MediaWiki Bot Framework',
-long_description=open('README.rst').read(),
+long_description=open('pypi_description.rst').read(),
 keywords=('pywikibot python mediawiki bot wiki framework '
   'wikimedia wikipedia pwb pywikipedia API'),
 maintainer='The Pywikibot team',

-- 
To view, visit https://gerrit.wikimedia.org/r/365268
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings