On Sat, Oct 10, 2009 at 2:07 AM, "Martin v. Löwis" <[email protected]> wrote: >> Any idea how to test rst so it renders properly. This rst displays >> just fine in moinmoin, so is there anything special about Pypi as far >> as rendering? > > You can try rendering it locally, with the function processDescription > in > > https://svn.python.org/packages/trunk/pypi/store.py > I've checked that out but I can't still get it to render properly.
I found 2 issues possibly. 1. when you do python setup.py bdist the PKG-INFO has the description but it has 8 spaces in front of every line. If a description had a space in the beginning of the line(for tab) it is not there anymore, but rather any space is replaced by the initial 8 spaces. This means your alignment will be off. This causes another problem; if you remove the space and replace it with initial 8 spaces, what happens to the lines like this: this is a code:: [space]some code here Since above line requires a space for it to be rendered properly I don't see how this will work for anybody. 2. Even if I copy paste my original docstring pypi still doesn't render it. moinoin does, rst render does (http://www.tele3.cz/jbar/rest/rest.html). Any help on this would be welcomed. 3 out of 4 packages I have don't render, and the one that does is very short. Thanks, Lucas > Regards, > Martin > -- Setup CalendarServer for your company. http://lucasmanual.com/mywiki/CalendarServer Automotive Recall Database - See if you vehicle has a recall http://lucasmanual.com/recall
PKG-INFO
Description: Binary data
#Gets setuptools
try:
from setuptools import setup, find_packages
except ImportError:
from ez_setup import use_setuptools
use_setuptools()
from setuptools import setup, find_packages
import sys, os
version = '0.8.90'
setup(name='datahub',
version=version,
description="Data Hub",
long_description="""\
DataHub
=======
* Datahub is a tool that allows faster download/crawl, parse, load, and visualize of data. It achieves this by allowing you to divide each step into its own work folders. In each work folder you get a sample files that you can start coding in.
* Datahub is for people who found some interesting data source for them, they want to download it, parse it, load it into database, provide some documentation, and visualize it. Datahub will speed up the process by creating folder for each of these actions. You will create all the programs from our base default template and move on to analyzing the data in no time.
6 Rules for Data Privacy
========================
1. Sensitive, and possibly inaccurate, information may not be used against people in financial, political, employment, and health-care settings.
2. All information should not be forcing anybody to hide or protect them self against improper information use that significantly limits persons ability to exercise his/her right to freedom of association.
3. Implement a basic form of information accountability by tracking identifying information that identifies a person or corporation and could be used to held that person/corporation accountable for the compliance.
4. There should be no restriction on use of data unless specified by laws and these privacy rules.
5. Privacy is protected not by limiting the collection of data, but by placing strict rules on how the data may be used. Data that can be used in financial, political, employment, and health-care settings cannot be used for marketing and other profiling. Strict penalties should be imposed by for the breach of these use limitations. Actions that involve financial, political, employment, and health-care settings decision must be justified with reference to the specific data on which the decision was based. If the person/corporation discovers that the data is inaccurate, he or she may demand that it be corrected. Stiff financial penalties should be imposed against the agency that does not make the appropriate corrections.
6. Achieve greater information accountability only by making better use of the information that is collected, retaining the data that is necessary to hold data users responsible for policy compliance. Build the system that encourages compliance, and maximizes the possibility of accountability of violations. Technology should supplant the rules because users are aware of what they are and because they know there will be consequences, after the fact.
Install DataHub
===============
The best way to get started with datahub is to install it in the following way.
Setup virtualenv which will keep the installation in a separate directory::
virtualenv --no-site-packages datahubENV
New python executable in datahubENV/bin/python
Installing setuptools............done.
source datahubENV/bin/activate
Create DataHub based project
============================
Datahub is a paster template so you run it as follows::
paster create --list-templates
paster create -t datahub
You should see something like this::
paster create -t datahub
Selected and implied templates::
PasteScript#basic_package A basic setuptools-enabled package
datahub#datahub DataHub is a tool to help you datamine(crawl, parse, and load) any data.
Enter project name: myproject
Variables:
egg: myproject
package: myproject
project: myproject
Enter version (Version (like 0.1)) ['']: 0.1
Enter description (One-line description of the package) ['']: my project
Enter long_description (Multi-line description (in reST)) ['']: this is long description
Enter keywords (Space-separated keywords/tags) ['']: datahub dataprocess gov
Enter author (Author name) ['']: myname
Enter author_email (Author email) ['']: myemail
Enter url (URL of homepage) ['']: mywebsite
Enter license_name (License name) ['']: gpl
Enter zip_safe (True/False: if the package can be distributed as a .zip file) [False]:
Creating template basic_package
Creating directory ./myproject
Recursing into +package+
Creating ./myproject/myproject/
Copying __init__.py to ./myproject/myproject/__init__.py
Copying setup.cfg to ./myproject/setup.cfg
Copying setup.py_tmpl to ./myproject/setup.py
Creating template datahub
Recursing into +package+
Copying README.txt_tmpl to ./myproject/myproject/README.txt
Recursing into crawl
Creating ./myproject/myproject/crawl/
Copying Readme.txt_tmpl to ./myproject/myproject/crawl/Readme.txt
Copying __init__.py to ./myproject/myproject/crawl/__init__.py
Copying crawl.sh to ./myproject/myproject/crawl/crawl.sh
Copying download.sh to ./myproject/myproject/crawl/download.sh
Copying download_list.txt_tmpl to ./myproject/myproject/crawl/download_list.txt
Copying harvestman-+package+.xml to ./myproject/myproject/crawl/harvestman-myproject.xml
Recursing into hdf5
Creating ./myproject/myproject/hdf5/
Copying READEM_hdf5.txt_tmpl to ./myproject/myproject/hdf5/READEM_hdf5.txt
Copying __init__.py to ./myproject/myproject/hdf5/__init__.py
Recursing into load
Creating ./myproject/myproject/load/
Copying __init__.py to ./myproject/myproject/load/__init__.py
Copying load.py to ./myproject/myproject/load/load.py
Copying load.sh to ./myproject/myproject/load/load.sh
Copying model.py to ./myproject/myproject/load/model.py
Recursing into parse
Creating ./myproject/myproject/parse/
Copying __init__.py to ./myproject/myproject/parse/__init__.py
Copying parse.sh_tmpl to ./myproject/myproject/parse/parse.sh
Copying process.sh_tmpl to ./myproject/myproject/process.sh
Recursing into wiki
Creating ./myproject/myproject/wiki/
Copying REAME.wiki_tmpl to ./myproject/myproject/wiki/REAME.wiki
Running /home/lucas/tmp/lmENV/bin/python setup.py egg_info
Manually creating paster_plugins.txt (deprecated! pass a paster_plugins keyword to setup() instead)
Adding datahub to paster_plugins.txt
Go into the myproject folder and start coding.
The folder structure looks like this::
myproject
|-- myproject
| |-- README.txt
| |-- __init__.py
| |-- crawl
| | |-- Readme.txt
| | |-- __init__.py
| | |-- crawl.sh
| | |-- download.sh
| | |-- download_list.txt
| | `-- harvestman-myproject.xml
| |-- hdf5
| | |-- READEM_hdf5.txt
| | `-- __init__.py
| |-- load
| | |-- __init__.py
| | |-- load.py
| | |-- load.sh
| | `-- model.py
| |-- parse
| | |-- __init__.py
| | `-- parse.sh
| |-- process.sh
| `-- wiki
| `-- REAME.wiki
|-- myproject.egg-info
| |-- PKG-INFO
| |-- SOURCES.txt
| |-- dependency_links.txt
| |-- entry_points.txt
| |-- not-zip-safe
| |-- paster_plugins.txt
| `-- top_level.txt
|-- setup.cfg
`-- setup.py
Get stared with your data project
=================================
crawl
~~~~~
Crawl folder is where you crawl data. You have two choices as far as downloading. For each choice there are pre-build files, so just follow this:
wget
----
With wget you can download the files if the list of files is not big. There is a download_list.txt that will hold the url you want to download. You can specify wild cards like `*.zip`, `*.pdf`, `*.txt` etc. Download.sh is a shell script that calls wget and downloads files. By default it will only download files if they are newer then what you downloaded, and it will only download the missing parts. This saves your bandwidth and does not re-download the whole files each time.
The only thing you need to do is edit download_list.txt::
cd crawl
#Edit download_list.txt and add url of files you want to download
vi download_list.txt
sh download.sh
You second options is harvestman, see docs.
parse
~~~~~
Parse is where you parse the files. This is a gray area where you take control. This can be as simple as unziping a file, or writing a simple script to replace some names, or some extensive parsing program. It all depends on the project data. Add the code to parse.sh, or write your own parser and add the running code to parse.sh so that later you just run::
sh parse.sh
load
~~~~
Load is where you load your data to the database. There is a laod.py file that has a sample database structure for 4 columns. You can use that file as your starting point. It has everything from defining new columns, to setting up database and reading over a csv file in parse folder and uplaoding it to database. Read the load.sh and load.py files and make special not where it says [CHANGE]. These are the portion where you changed the namem, add columns, tell it where the file is. When all done, just run it::
sh load.sh
process.sh
~~~~~~~~~~
Above all folders there is a file called process.sh. This files has a build in structure to go into crawl folder and start crawl.sh, then go into parse and run parse.sh, and then go into load and run load.sh script. With this file you control the whole process. When its all ready, a user can get your project, install any necessary programs and just simply run::
sh process.sh
This will crawl, parse, and load the data.
Enjoy.
""",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='datahub datamining csv tsv mdb crawl harvest webdata gov public data',
author='Lukasz Szybalski',
author_email='[email protected]',
url='http://datahub.sourceforge.net/',
license='GPL',
packages=find_packages(exclude=['ez_setup', 'examples']),
include_package_data=True,
zip_safe=False,
install_requires=[
"pastescript>=1.0" ,
"pastescript!=1.7.2" ,
"cheetah>=2.0",
# -*- Extra requirements: -*-
],
entry_points="""
[paste.paster_create_template]
#datahub = datahub.datahub:FrameworkTemplate
datahub = datahub:FrameworkTemplate
""",
)
_______________________________________________ Catalog-SIG mailing list [email protected] http://mail.python.org/mailman/listinfo/catalog-sig
