charlesflynn / eve-docs Goto Github PK
View Code? Open in Web Editor NEWGenerates documentation for Eve APIs
License: MIT License
Generates documentation for Eve APIs
License: MIT License
While the URL to my resource is /contact/<regex("[a-f0-9]{24}"):contact>/event
, the eve-docs generated URL for it is /contactevent
.
Versions:
As it says on the tin; it would be great to be able to see the expected output.
Howdy,
I'm getting a weird behavior when installing Eve-docs from pypi. Both your code and pypi report the latest version as 0.1.4, but when installing I can only see up to version 0.1.2.
Here are the logs for a clean install of eve-docs:
HCN@ODIN /c/temp/eve-docs-test
$ virtualenv _env --no-site-packages --always-copy
New python executable in _env\Scripts\python.exe
Installing setuptools, pip...done.
HCN@ODIN /c/temp/eve-docs-test
$ source _env/Scripts/activate
(_env)
HCN@ODIN /c/temp/eve-docs-test
$ pip list
pip (1.5.4)
setuptools (2.2)
(_env)
HCN@ODIN /c/temp/eve-docs-test
$ pip install eve-docs==0.1.4
Downloading/unpacking eve-docs==0.1.4
Could not find a version that satisfies the requirement eve-docs==0.1.4 (from versions: 0.1.0, 0.1.1, 0.1.2)
Cleaning up...
No distributions matching the version for eve-docs==0.1.4
Storing debug log for failure in ....
Notice the error message from pip: Could not find a version that satisfies the requirement eve-docs==0.1.4 (from versions: 0.1.0, 0.1.1, 0.1.2)
Is there a way to generate markdown instead of HTML/JSON?
Hello everyone,
Eve author and maintainer here. I just released Eve-Swagger which is a Eve extension providing integration with Swagger, the standard for API documentation and tooling. Amongst other things, Eve-Swagger allows to achieve functionalities which are similar to those offered by Eve-Docs. For more information see http://nicolaiarocci.com/announcing-eve-swagger/.
For the record, in the past I tried to get in touch with the Eve-docs author via mail, Twitter and LinkedIn, with no luck. Since the Eve-Docs project itself seems abandoned right now (last commit was in 2014), I thought he would not mind me posting here in order to let eve-docs users know about the new project. I am also flagging Eve-docs as inactive on the official Eve extensions page.
pip install Eve-docs
...
Installing collected packages: Eve-docs, Flask-Bootstrap
Running setup.py install for Eve-docs
File "/opt/pixspan/app/pixdev_3/lib/python3.4/site-packages/eve_docs/config.py", line 11
print base
^
SyntaxError: Missing parentheses in call to 'print'
Running setup.py install for Flask-Bootstrap
Successfully installed Eve-docs Flask-Bootstrap
Cleaning up...
Currently, the GET end points raw don't expand. By the way, it can be confusing to have a link/cursor.
I propose we document filtering and sorting (if enabled) :)
Hey @charlesflynn, can you add eve-docs to PyPI so that I can install it from pip? I imagine this is pretty easy since you already have the setup.py
file filled out.
Thanks!
I was looking something similar but inside out.
http://localhost - should display docs.
http://localhost/api - should hold eve. So that we access localhost/api/works or localhost/api/people.
Is this possible? Please suggest.
Is it ignored intentionnally ?
When I add eve-doc and try to access I got this error, any idea ?
Traceback (most recent call last):
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1836, in __call__
return self.wsgi_app(environ, start_response)
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1820, in wsgi_app
response = self.make_response(self.handle_exception(e))
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1403, in handle_exception
reraise(exc_type, exc_value, tb)
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1817, in wsgi_app
response = self.full_dispatch_request()
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1477, in full_dispatch_request
rv = self.handle_user_exception(e)
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1381, in handle_user_exception
reraise(exc_type, exc_value, tb)
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1475, in full_dispatch_request
rv = self.dispatch_request()
File "/usr/lib/python2.6/site-packages/flask/app.py", line 1461, in dispatch_request
return self.view_functions[rule.endpoint](**req.view_args)
File "/usr/lib/python2.6/site-packages/eve_docs/__init__.py", line 11, in index
cfg = get_cfg()
File "/usr/lib/python2.6/site-packages/eve_docs/config.py", line 11, in get_cfg
base = '{}://{}'.format(protocol, base['href'])
TypeError: string indices must be integers, not str
P.S. Sorry for posting this at eve repo on first time reporting.
When trying to generate docs, I encounter this error:
AssertionError: A blueprint's name collision occurred between <flask.blueprints.Blueprint object at 0x7f89153c7e90> and <flask.blueprints.Blueprint object at 0x7f8915383710>. Both share the same name "bootstrap". Blueprints that are created on the fly need unique names.
I just used the method given in the doc.
It would be great to have access to old releases via PyPI rather than only the latest release. Imagine you specify a specific version in your requirements.txt
requirements installation will fail once a new release has been pushed and the old replaced.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.