Permalink
Browse files

Bug 815832 - remove README.md files and point setup.py long_descripti…

  • Loading branch information...
1 parent 9370129 commit 15fa18aae3fcc07587d7878216b44ae26847a988 Jeff Hammel committed Dec 12, 2012
View
@@ -1,5 +1,8 @@
:mod:`mozcrash` --- Print stack traces from minidumps left behind by crashed processes
======================================================================================
+Gets stack traces out of processes that have crashed and left behind
+a minidump file using the Google Breakpad library.
+
.. automodule:: mozcrash
:members: check_for_crashes
View
@@ -8,5 +8,71 @@ behaviour.
:mod:`mozinfo` --- Get system information
-----------------------------------------
+Throughout `mozmill <https://developer.mozilla.org/en/Mozmill>`_
+and other Mozilla python code, checking the underlying
+platform is done in many different ways. The various checks needed
+lead to a lot of copy+pasting, leaving the reader to wonder....is this
+specific check necessary for (e.g.) an operating system? Because
+information is not consolidated, checks are not done consistently, nor
+is it defined what we are checking for.
+
+`mozinfo <https://github.com/mozilla/mozbase/tree/master/mozinfo>`_
+proposes to solve this problem. mozinfo is a bridge interface,
+making the underlying (complex) plethora of OS and architecture
+combinations conform to a subset of values of relavence to
+Mozilla software. The current implementation exposes relavent key,
+values: ``os``, ``version``, ``bits``, and ``processor``. Additionally, the
+service pack in use is available on the windows platform.
+
+
+API Usage
+---------
+
+mozinfo is a python package. Downloading the software and running
+``python setup.py develop`` will allow you to do ``import mozinfo``
+from python.
+`mozinfo.py <https://github.com/mozilla/mozbase/blob/master/mozinfo/mozinfo.py>`_
+is the only file contained is this package,
+so if you need a single-file solution, you can just download or call
+this file through the web.
+
+The top level attributes (``os``, ``version``, ``bits``, ``processor``) are
+available as module globals::
+
+ if mozinfo.os == 'win': ...
+
+In addition, mozinfo exports a dictionary, ``mozinfo.info``, that
+contain these values. mozinfo also exports:
+
+- ``choices``: a dictionary of possible values for os, bits, and
+ processor
+- ``main``: the console_script entry point for mozinfo
+- ``unknown``: a singleton denoting a value that cannot be determined
+
+``unknown`` has the string representation ``"UNKNOWN"``.
+``unknown`` will evaluate as ``False`` in python::
+
+ if not mozinfo.os: ... # unknown!
+
+
+Command Line Usage
+------------------
+
+mozinfo comes with a command line program, ``mozinfo`` which may be used to
+diagnose one's current system.
+
+Example output::
+
+ os: linux
+ version: Ubuntu 10.10
+ bits: 32
+ processor: x86
+
+Three of these fields, os, bits, and processor, have a finite set of
+choices. You may display the value of these choices using
+``mozinfo --os``, ``mozinfo --bits``, and ``mozinfo --processor``.
+``mozinfo --help`` documents command-line usage.
+
+
.. automodule:: mozinfo
:members:
View
@@ -1,6 +1,10 @@
:mod:`mozlog` --- Easy, configurable and uniform logging
========================================================
+Mozlog is a python package intended to simplify and standardize logs
+in the Mozilla universe. It wraps around python's logging module and
+adds some additional functionality.
+
.. automodule:: mozlog
:members: getLogger
View
@@ -3,23 +3,14 @@
# You can obtain one at http://mozilla.org/MPL/2.0/.
from setuptools import setup
-import sys
-import os
-
-here = os.path.dirname(os.path.abspath(__file__))
-try:
- filename = os.path.join(here, 'README.md')
- description = file(filename).read()
-except:
- description = ''
PACKAGE_NAME = "ManifestDestiny"
PACKAGE_VERSION = '0.5.6'
setup(name=PACKAGE_NAME,
version=PACKAGE_VERSION,
description="Library to create and manage test manifests",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org/",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='mozilla manifests',
author='Mozilla Automation and Testing Team',
View
@@ -2,24 +2,16 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
-import os
from setuptools import setup
PACKAGE_VERSION = '0.2'
-# take description from README
-here = os.path.dirname(os.path.abspath(__file__))
-try:
- description = file(os.path.join(here, 'README.md')).read()
-except (OSError, IOError):
- description = ''
-
deps = ['mozdevice >= 0.16', 'marionette_client >= 0.5.2']
setup(name='mozb2g',
version=PACKAGE_VERSION,
description="B2G specific code for device automation",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org/",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='',
author='Mozilla Automation and Testing Team',
View
@@ -1,12 +0,0 @@
-# Mozcrash
-
-Package for getting a stack trace out of processes that have crashed and left behind a minidump file using the Google Breakpad library.
-
-
-## Usage example
-
-TODO
-
- import mozcrash
-
- #...
View
@@ -2,26 +2,17 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
-
-import os
from setuptools import setup
PACKAGE_VERSION = '0.1'
-# get documentation from the README
-try:
- here = os.path.dirname(os.path.abspath(__file__))
- description = file(os.path.join(here, 'README.md')).read()
-except (OSError, IOError):
- description = ''
-
# dependencies
-deps = ['']
+deps = []
setup(name='mozcrash',
version=PACKAGE_VERSION,
description="Library for printing stack traces from minidumps left behind by crashed processes",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org/",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='mozilla',
author='Mozilla Automation and Tools team',
View
@@ -1,5 +0,0 @@
-[mozdevice](https://github.com/mozilla/mozbase/tree/master/mozdevice) provides
-an interface to interact with a remote device such as an Android phone connected
-to a workstation. Currently there are two implementations of the interface: one
-uses a TCP-based protocol to communicate with a server running on the device,
-another uses Android's adb utility.
View
@@ -2,24 +2,16 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
-import os
from setuptools import setup
PACKAGE_VERSION = '0.17'
-# take description from README
-here = os.path.dirname(os.path.abspath(__file__))
-try:
- description = file(os.path.join(here, 'README.md')).read()
-except (OSError, IOError):
- description = ''
-
deps = ['mozprocess == 0.8']
setup(name='mozdevice',
version=PACKAGE_VERSION,
description="Mozilla-authored device management",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org/",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='',
author='Mozilla Automation and Testing Team',
View
@@ -1,4 +0,0 @@
-mozfile is a convenience library for taking care of some common file-related
-tasks in automated testing, such as extracting files or recursively removing
-directories.
-
View
@@ -2,23 +2,14 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
-
-import os
from setuptools import setup
PACKAGE_VERSION = '0.1'
-# get documentation from the README
-try:
- here = os.path.dirname(os.path.abspath(__file__))
- description = file(os.path.join(here, 'README.md')).read()
-except (OSError, IOError):
- description = ''
-
setup(name='mozfile',
version=PACKAGE_VERSION,
description="Library of file utilities for use in Mozilla testing",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org/",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='mozilla',
author='Mozilla Automation and Tools team',
View
@@ -1 +0,0 @@
-basic python webserver, tested with talos
View
@@ -2,23 +2,15 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
-import os
from setuptools import setup
-try:
- here = os.path.dirname(os.path.abspath(__file__))
- description = file(os.path.join(here, 'README.md')).read()
-except IOError:
- description = None
-
PACKAGE_VERSION = '0.5'
-
deps = []
setup(name='mozhttpd',
version=PACKAGE_VERSION,
description="Python webserver intended for use with Mozilla testing",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org/",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='mozilla',
author='Mozilla Automation and Testing Team',
View
@@ -1,62 +0,0 @@
-Throughout [mozmill](https://developer.mozilla.org/en/Mozmill)
-and other Mozilla python code, checking the underlying
-platform is done in many different ways. The various checks needed
-lead to a lot of copy+pasting, leaving the reader to wonder....is this
-specific check necessary for (e.g.) an operating system? Because
-information is not consolidated, checks are not done consistently, nor
-is it defined what we are checking for.
-
-[MozInfo](https://github.com/mozilla/mozbase/tree/master/mozinfo)
-proposes to solve this problem. MozInfo is a bridge interface,
-making the underlying (complex) plethora of OS and architecture
-combinations conform to a subset of values of relavence to
-Mozilla software. The current implementation exposes relavent key,
-values: `os`, `version`, `bits`, and `processor`. Additionally, the
-service pack in use is available on the windows platform.
-
-
-# API Usage
-
-MozInfo is a python package. Downloading the software and running
-`python setup.py develop` will allow you to do `import mozinfo`
-from python.
-[mozinfo.py](https://github.com/mozilla/mozbase/blob/master/mozinfo/mozinfo.py)
-is the only file contained is this package,
-so if you need a single-file solution, you can just download or call
-this file through the web.
-
-The top level attributes (`os`, `version`, `bits`, `processor`) are
-available as module globals:
-
- if mozinfo.os == 'win': ...
-
-In addition, mozinfo exports a dictionary, `mozinfo.info`, that
-contain these values. mozinfo also exports:
-
-- `choices`: a dictionary of possible values for os, bits, and
- processor
-- `main`: the console_script entry point for mozinfo
-- `unknown`: a singleton denoting a value that cannot be determined
-
-`unknown` has the string representation `"UNKNOWN"`. unknown will evaluate
-as `False` in python:
-
- if not mozinfo.os: ... # unknown!
-
-
-# Command Line Usage
-
-MozInfo comes with a command line, `mozinfo` which may be used to
-diagnose one's current system.
-
-Example output:
-
- os: linux
- version: Ubuntu 10.10
- bits: 32
- processor: x86
-
-Three of these fields, os, bits, and processor, have a finite set of
-choices. You may display the value of these choices using
-`mozinfo --os`, `mozinfo --bits`, and `mozinfo --processor`.
-`mozinfo --help` documents command-line usage.
View
@@ -2,19 +2,10 @@
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
-
-import os
from setuptools import setup
PACKAGE_VERSION = '0.4'
-# get documentation from the README
-try:
- here = os.path.dirname(os.path.abspath(__file__))
- description = file(os.path.join(here, 'README.md')).read()
-except (OSError, IOError):
- description = ''
-
# dependencies
deps = []
try:
@@ -25,7 +16,7 @@
setup(name='mozinfo',
version=PACKAGE_VERSION,
description="Library to get system information for use in Mozilla testing",
- long_description=description,
+ long_description="see http://mozbase.readthedocs.org",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='mozilla',
author='Mozilla Automation and Testing Team',
Oops, something went wrong.

0 comments on commit 15fa18a

Please sign in to comment.