Skip to content

Commit

Permalink
meta: setup.py, add AUTHORS, add .gitignore, improve README, fix LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
zopieux committed Mar 6, 2016
1 parent 2ba4fdd commit e0103a1
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
__pycache__/
*.py[cod]
*$py.class
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ install:
- pip install .

script: python test.py

5 changes: 5 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
In 2012, this project was initiated by the Dart project team, from Google.
It is now archived at https://github.com/googlearchive/py-gfm

In March 2016, the project maintainer-ship was transferred to Alexandre
Macabies a.k.a zopieux.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Copyright 2012, the Dart project authors. All rights reserved.
Copyright 2016, Alexandre Macabies. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
Expand Down
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,42 @@
# GitHub-Flavored markdown for Python

This is an implementation of [GitHub-Flavored Markdown][gfm] written as an
extension to the Python [Markdown][md] library. It aims for maximal
compatibility with GitHub's rendering.


## Supported features

- Fenced code blocks
- Literal line breaks
- Tables
- Hyperlink parsing (`http`, `https`, `ftp`, `email` and `www` subdomains)
- Code highlighting (dummy, no actual syntactic coloration as-is)
- Mixed-style lists with no separation
- Links and images with whitespace
- Strikethrough
- Task lists


## Unsupported features

This implementation does not support all of GFM features.

### Unsupported by design

- Link to commits, issues, pull requests and user profiles: this is
application specific. Feel free to subclass the provided classes to
implement your own logic.

### Unsupported, but planned

- Horizontal rules
- Emojis


## License

BSD-style. See [LICENSE](/LICENSE).

[gfm]: http://github.github.com/github-flavored-markdown/
[md]: http://packages.python.org/Markdown/
14 changes: 8 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@
setup(
name='py-gfm',
version='0.1.2',
description='An implementation of Github-Flavored Markdown written as an extension to the Python Markdown library.',
author='Dart Team',
description='An implementation of Github-Flavored Markdown written as an '
'extension to the Python Markdown library.',
author='Dart Team, Alexandre Macabies',
author_email='[email protected]',
url='https://github.com/dart-lang/py-gfm',
download_url='https://github.com/dart-lang/py-gfm/tarball/0.1.2',
url='https://github.com/zopieux/py-gfm',
download_url='https://codeload.github.com/Zopieux/py-gfm/tar.gz/0.1.2',
packages=find_packages(),
include_package_data = True,
install_requires = ['setuptools', 'markdown'],
include_package_data=True,
install_requires=['setuptools', 'markdown'],
classifiers=[
'Environment :: Web Environment',
'Intended Audience :: Developers',
'Operating System :: OS Independent',
'Programming Language :: Python'
'Topic :: Text Processing :: Markup',
]
)

0 comments on commit e0103a1

Please sign in to comment.