https://github.com/jaredthecoder/stargazer
https://github.com/jaredthecoder/stargazer
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jaredthecoder/stargazer
- Owner: jaredthecoder
- License: mit
- Created: 2015-05-22T11:55:48.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-08-13T18:15:08.000Z (over 10 years ago)
- Last Synced: 2025-01-06T05:21:35.468Z (about 1 year ago)
- Language: Python
- Size: 125 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Stargazer
==========
Version: 0.1.0
Website: NULL
Authors: Jared Smith, Joseph Connor, Luke Wegryn
Contact: smith@utk.edu
###Overview:
---
Stargazer is a tool that recieves a hostname on the command line interface (CLI) and attempts to
find and map out any REST API's on the hostname. With this mapping, a nice report is generated of
all the endpoints and a concise description of each.
###Installation:
---
Currently, the tool is NOT available to install with pip. This will be added in the future.
###Usage:
---
- Runs with Python 2.7.x
- Getting started on Mac OS X and Linux based distributions (Ubuntu/Debian/Arch/etc):
- `virtualenv venv && source venv/bin/activate` -- Make a virtual environment (Use virtualenv people!) and activate it.
- `pip install -r requirements.text` -- Install dependencies.
- `python mapper.py -h` -- Detail of the CLI.
- When you're done:
- `deactivate` -- Deactivate the virtual environment.
###TODO:
---
- New name for the project/tool
- Create pip package for the project