search

boakley / robotframework-hub

Web app for accessing robot framework assets
https://github.com/boakley/robotframework-hub/wiki
Apache License 2.0
169 stars 60 forks source link

Need a proper documentation on Using the HUB #37

Closed dhoomakethu closed 9 years ago

dhoomakethu commented 9 years ago

Hi,

I have been trying a lot to get the hub working for my robot test suite with out any success. The docuementation "Want to browse your local robotframework assets? Just include the path to your test suites or resource files on the command line:

$ python -m rfhub /path/to/test/suite"  is not helping much.

If i try to pass the root folder path of my test suite as above where in I have my resource file in .tsv format,which in turn includes the actual resource files and library import information ,it just loops through all the subfolders and prints exclude_patterns: []. when i open http://localhost:7070/doc/ , I just see the documentation of the standard robot libraries and not the test libraries I have.

Am i missing something here or the rfhub does not support the tsv format yet ?

I would love to have a proper docuementation on how to use this cool project. Regards sanjay

boakley commented 9 years ago

That's a bug. Right now it's not looking for .tsv files. I'll fix that as soon as I can.

On Thu, Oct 16, 2014 at 10:05 PM, dhoomakethu notifications@github.com wrote:

Hi,

I have been trying a lot to get the hub working for my robot test suite with out any success. The docuementation "Want to browse your local robotframework assets? Just include the path to your test suites or resource files on the command line:

$ python -m rfhub /path/to/test/suite" is not helping much.

If i try to pass the root folder path of my test suite as above where in I have my resource file in .tsv format,which in turn includes the actual resource files and library import information ,it just loops through all the subfolders and prints exclude_patterns: []. when i open http://localhost:7070/doc/ , I just see the documentation of the standard robot libraries and not the test libraries I have.

Am i missing something here or the rfhub does not support the tsv format yet ?

I would love to have a proper docuementation on how to use this cool project. Regards sanjay

— Reply to this email directly or view it on GitHub https://github.com/boakley/robotframework-hub/issues/37.

dhoomakethu commented 9 years ago

HI,

Thanks for the fix , but is there a way the hub can parse the library files included in the resource file and get the keyword documentation of those libraries ? With this fix , I can only see the user defined keywords in the resource file .

Sanjay

boakley commented 9 years ago

The hub will parse any library it finds in any directories you tell it to look. When you do `python -m rfhub /some/path' it will attempt to parse all .xml, .py, .txt, .tsv and .robot files.

The hub does not recursively look for libraries that have been imported in a resource file. I don't think that's necessary since you can tell it which folders to search for keywords

On Wed, Oct 22, 2014 at 9:23 AM, dhoomakethu notifications@github.com wrote:

HI,

Thanks for the fix , but is there a way the hub can parse the library files included in the resource file and get the keyword documentation of those libraries ? With this fix , I can only see the user defined keywords in the resource file .

Sanjay

— Reply to this email directly or view it on GitHub https://github.com/boakley/robotframework-hub/issues/37#issuecomment-60092407 .

dhoomakethu commented 9 years ago

Hmmm, in that case Is there a way I can provide an exclude list as well ? here is the situation , I do not want the documentation of all the python libraries in the path I provide ,the resource file tells me what exactly are imported (basically wrappers around the other modules) ,so if there is a way I can get the documentation of the only modules I import excluding others,that would be helpful. I will also try to see if I can work with your code and tune to my needs .

Thanks Sanjay

boakley commented 9 years ago

Yes, i've been thinking about implementing a .rfhubignore file, I just haven't had the time to implement it.

--bryan

On Oct 22, 2014, at 11:15 PM, dhoomakethu notifications@github.com wrote:

Hmmm, in that case Is there a way I can provide an exclude list as well ? here is the situation , I do not want the documentation of all the python libraries in the path I provide ,the resource file tells me what exactly are imported (basically wrappers around the other modules) ,so if there is a way I can get the documentation of the only modules I import excluding others,that would be helpful. I will also try to see if I can work with your code and tune to my needs .

Thanks Sanjay

— Reply to this email directly or view it on GitHub.

cdeng commented 8 years ago

@boakley I saw you had some code for .rfhubignore, is it fully implemented yet? Thanks.

boakley commented 8 years ago

No, I'm sorry, I haven't finished with the implementation of that feature yet.

--bryan

On Mon, Feb 1, 2016 at 4:03 PM, Cheng Deng notifications@github.com wrote:

@boakley https://github.com/boakley I saw you had some code for .rfhubignore, is it fully implemented yet? Thanks.

— Reply to this email directly or view it on GitHub https://github.com/boakley/robotframework-hub/issues/37#issuecomment-178218776 .