Mixing
Generate a “contents” page using Cherrypy
I have a (company) server running CherryPy (Python 2.7). Within the server we have a large number of custom services (20+) mounted to various URLs. As a small team it is hard for us to maintain documentation for these URLs and services; especially when they are updated or new services are added.
What I would like to do is create a dynamic 'contents' page that pulls in (a) all mounted apps (b) the URL and (c) documentation/usage notes. For instance:
| Service | URL | Documentation |
|----------|-------------------------------|----------------------------|
| Report A | site.com/reporting/A/run | `?user=username&date=date` |
| Report A | site.com/reporting/A/index | `See all parameters` |
| Change | site.com/change/A/make_change | `?object=id` |
| Change | site.com/change/A/autochange | Only use for crontasks |
Here is what I have tried:
Pycco
Option one: Using Pycco to create HTML from the wsgi.py file. This is great as it means we have a list of all mounted apps. However, storing service documentation using inline comments on each of the paths is a little excessive, creates a lot of inflation in the wsgi file, and doesn't really solve the issue of programmers updating their individual modules without updating wsgi.py.
CherryPy.tree.apps
Using something like >>> [k for k,v in cherrypy.tree.apps.iteritems()] I can create a list of all URLs. However, this is very basic - no ability to add in information about the app itself. It would be great to be able to tie the list of URLs back to the individual modules, and use the module documentation to somehow generate a contents page.
Can anyone please advise? I can install packages as needed but CherryPy is a requisite.
python-2.7 wsgi cherrypy
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
add a comment |
I have a (company) server running CherryPy (Python 2.7). Within the server we have a large number of custom services (20+) mounted to various URLs. As a small team it is hard for us to maintain documentation for these URLs and services; especially when they are updated or new services are added.
What I would like to do is create a dynamic 'contents' page that pulls in (a) all mounted apps (b) the URL and (c) documentation/usage notes. For instance:
| Service | URL | Documentation |
|----------|-------------------------------|----------------------------|
| Report A | site.com/reporting/A/run | `?user=username&date=date` |
| Report A | site.com/reporting/A/index | `See all parameters` |
| Change | site.com/change/A/make_change | `?object=id` |
| Change | site.com/change/A/autochange | Only use for crontasks |
Here is what I have tried:
Pycco
Option one: Using Pycco to create HTML from the wsgi.py file. This is great as it means we have a list of all mounted apps. However, storing service documentation using inline comments on each of the paths is a little excessive, creates a lot of inflation in the wsgi file, and doesn't really solve the issue of programmers updating their individual modules without updating wsgi.py.
CherryPy.tree.apps
Using something like >>> [k for k,v in cherrypy.tree.apps.iteritems()] I can create a list of all URLs. However, this is very basic - no ability to add in information about the app itself. It would be great to be able to tie the list of URLs back to the individual modules, and use the module documentation to somehow generate a contents page.
Can anyone please advise? I can install packages as needed but CherryPy is a requisite.
python-2.7 wsgi cherrypy
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
I've build some traversal in order to build a map of handlers to urls, here's src: github.com/GDG-Ukraine/gdg.org.ua/blob/master/src/GDGUkraine/… . I hope that it'll give you some idea of how to start with it.
– webKnjaZ
Jan 2 at 22:39
add a comment |
I have a (company) server running CherryPy (Python 2.7). Within the server we have a large number of custom services (20+) mounted to various URLs. As a small team it is hard for us to maintain documentation for these URLs and services; especially when they are updated or new services are added.
What I would like to do is create a dynamic 'contents' page that pulls in (a) all mounted apps (b) the URL and (c) documentation/usage notes. For instance:
| Service | URL | Documentation |
|----------|-------------------------------|----------------------------|
| Report A | site.com/reporting/A/run | `?user=username&date=date` |
| Report A | site.com/reporting/A/index | `See all parameters` |
| Change | site.com/change/A/make_change | `?object=id` |
| Change | site.com/change/A/autochange | Only use for crontasks |
Here is what I have tried:
Pycco
Option one: Using Pycco to create HTML from the wsgi.py file. This is great as it means we have a list of all mounted apps. However, storing service documentation using inline comments on each of the paths is a little excessive, creates a lot of inflation in the wsgi file, and doesn't really solve the issue of programmers updating their individual modules without updating wsgi.py.
CherryPy.tree.apps
Using something like >>> [k for k,v in cherrypy.tree.apps.iteritems()] I can create a list of all URLs. However, this is very basic - no ability to add in information about the app itself. It would be great to be able to tie the list of URLs back to the individual modules, and use the module documentation to somehow generate a contents page.
Can anyone please advise? I can install packages as needed but CherryPy is a requisite.
python-2.7 wsgi cherrypy
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
I have a (company) server running CherryPy (Python 2.7). Within the server we have a large number of custom services (20+) mounted to various URLs. As a small team it is hard for us to maintain documentation for these URLs and services; especially when they are updated or new services are added.
What I would like to do is create a dynamic 'contents' page that pulls in (a) all mounted apps (b) the URL and (c) documentation/usage notes. For instance:
| Service | URL | Documentation |
|----------|-------------------------------|----------------------------|
| Report A | site.com/reporting/A/run | `?user=username&date=date` |
| Report A | site.com/reporting/A/index | `See all parameters` |
| Change | site.com/change/A/make_change | `?object=id` |
| Change | site.com/change/A/autochange | Only use for crontasks |
Here is what I have tried:
Pycco
Option one: Using Pycco to create HTML from the wsgi.py file. This is great as it means we have a list of all mounted apps. However, storing service documentation using inline comments on each of the paths is a little excessive, creates a lot of inflation in the wsgi file, and doesn't really solve the issue of programmers updating their individual modules without updating wsgi.py.
CherryPy.tree.apps
Using something like >>> [k for k,v in cherrypy.tree.apps.iteritems()] I can create a list of all URLs. However, this is very basic - no ability to add in information about the app itself. It would be great to be able to tie the list of URLs back to the individual modules, and use the module documentation to somehow generate a contents page.
Can anyone please advise? I can install packages as needed but CherryPy is a requisite.
python-2.7 wsgi cherrypy
python-2.7 wsgi cherrypy
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
asked Jan 2 at 1:59
JohnL_10JohnL_10
179112
179112
I've build some traversal in order to build a map of handlers to urls, here's src: github.com/GDG-Ukraine/gdg.org.ua/blob/master/src/GDGUkraine/… . I hope that it'll give you some idea of how to start with it.
– webKnjaZ
Jan 2 at 22:39
add a comment |
I've build some traversal in order to build a map of handlers to urls, here's src: github.com/GDG-Ukraine/gdg.org.ua/blob/master/src/GDGUkraine/… . I hope that it'll give you some idea of how to start with it.
– webKnjaZ
Jan 2 at 22:39
I've build some traversal in order to build a map of handlers to urls, here's src: github.com/GDG-Ukraine/gdg.org.ua/blob/master/src/GDGUkraine/… . I hope that it'll give you some idea of how to start with it.
– webKnjaZ
Jan 2 at 22:39
I've build some traversal in order to build a map of handlers to urls, here's src: github.com/GDG-Ukraine/gdg.org.ua/blob/master/src/GDGUkraine/… . I hope that it'll give you some idea of how to start with it.
– webKnjaZ
Jan 2 at 22:39
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54000420%2fgenerate-a-contents-page-using-cherrypy%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54000420%2fgenerate-a-contents-page-using-cherrypy%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
I've build some traversal in order to build a map of handlers to urls, here's src: github.com/GDG-Ukraine/gdg.org.ua/blob/master/src/GDGUkraine/… . I hope that it'll give you some idea of how to start with it.
– webKnjaZ
Jan 2 at 22:39