https://github.com/scieloorg/ratchet
Access Stats tool under Tornado Framework
https://github.com/scieloorg/ratchet
data-science
Last synced: 5 months ago
JSON representation
Access Stats tool under Tornado Framework
- Host: GitHub
- URL: https://github.com/scieloorg/ratchet
- Owner: scieloorg
- License: bsd-2-clause
- Created: 2012-08-07T16:15:26.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2025-05-08T07:26:35.000Z (about 1 year ago)
- Last Synced: 2025-05-08T08:31:15.023Z (about 1 year ago)
- Topics: data-science
- Language: Python
- Homepage:
- Size: 311 KB
- Stars: 2
- Watchers: 15
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.txt
- Changelog: CHANGES.txt
- License: LICENSE
Awesome Lists containing this project
README
Ratchet
=======
Ratchet is an access statistics tool made over Tornado Framework plus MongoDB. This tool was made
thinking in create a common and easy to use tool/api to register accesses made to scientific
publications, considering the accesses to the Journals, Issues and articles level.
Downloading Ratchet
===================
**Clonning from Github**
git clone git://github.com/scieloorg/ratchet.git
**Downloading**
https://github.com/scieloorg/ratchet/tags
How to Install
==============
Compatible with:
* OSX (Tested)
* Linux (Tested)
* Windows (Maybe! Good luck! Who knows?)
Pre-requirements
----------------
* virtualenv (http://www.virtualenv.org/en/latest/index.html#installation)
* pip (http://www.pip-installer.org/en/latest/installing.html)
* mongodb (http://www.mongodb.org/downloads)
* Tornado (http://www.tornadoweb.org/)
Creating Virtual Environment
----------------------------
cd ratchet
virtualenv --no-site-packages ratchet-env
source ratchet-env/bin/activate
Installing the Applications
---------------------------
pip install -r requirements.txt
Installing and Starting MongoDB
-------------------------------
MongoDB could be installed at the virtual environment ratchet-env if it is not installed in the server
**Installing MongoDB**
cd ratchet-env/bin
wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-2.0.7.tgz
tar -xvf mongodb-linux-x86_64-2.0.7.tgz
ln -s mongodb-linux-x86_64-2.0.7/bin/mongod
**Starting MongoDB**
Just run the script!
./mongodb_start.sh
Running Server
==============
python ratchet.py
By default, the server will run at localhost:8888 with the mongoDB server at localhost:27017.
For more details about how customize the server, run:
python ratchet.py --help
Documentation
=============
All detailed documentations are available at: http://docs.scielo.org/projects/ratchet/en/latest/index.html