Skip to main content

A simple counter to keep a record of number of visitors who visit your website.

Project description

EasyVisitors

made-with-python PyPI - Python Version GitHub last commit PyPI version fury.io GitHub issues PyPI - Wheel PyPI license

EasyVisitors is a simple to use Django App that counts website visitors and displays them without any hassles. It uses cookies to keep a track of how many people visited you website and doesnot increments simply upon a refresh unlike other simple counters.

  • Easy to use
  • Easy to setup
  • Easy to configure
  • Easy to customize

Installation

Installation is same for virtualenv and non virtualenv (because it is that simple XD)

> pip install EasyVisitors

Configration

In settings.py of your django project -

INSTALLED_APPS = [
    ...
    'EasyVisitors',
    ...
]
MIDDLEWARE = [
    ...
    'EasyVisitors.middleware.VisitorCounterMiddleware',
    ...
]

Getting Started

It is a local counter so it is necessary to create some space for recording it's values in the database. But no worries all of it has been taken care off. You just have to run -

> python manage.py makemigrations EasyVisitors
> python manage.py migrate EasyVisitors

This will create a simple table to store the values of the counter in the database. This step is very important as without these migrations the app wont be able to run as it wont be able to store it's values and hence will show an error.

Using the app

This simple to configure app is also simple to use. To use the value of counter in your templates -

{{ request.visitors }}

And to use it anywhere else -

request.visitors

Customization

In settings.py of your django project you can customize some aspects of EasyVisitors app -

  1. EASY_COUNTER_VISITOR_ALIVE_TIME - It determines how long a visitor is concidered as a unit and after that time, that user is concidered as a new vsitor. Datatype : int
    Unit : seconds
    Default: 300
     
  2. EASY_COUNTER_IGNORED_PATHS - List comprising of all paths, which donot alter the state of the counter upon being visited.
    Datatype : list
    Default: ['/admin']
     
  3. EASY_COUNTER_RESET - Value for the counter to begin from upon next refresh of any page. If it has any value except None then the counter will stay at that value forever untill changed to None after which it begins counting from that value.
    Datatype : int
    Default: None
    OnChange : Counter stay at the changed value
     

Creator

Deekshant Wadhwa

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

EasyVisitors-0.1.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

EasyVisitors-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file EasyVisitors-0.1.0.tar.gz.

File metadata

  • Download URL: EasyVisitors-0.1.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.4

File hashes

Hashes for EasyVisitors-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3b9b7b1a98a00f129a5a0ac05628699420945355d493865a7f77c452d776599a
MD5 d2e10a532c94c4c420f1cd2c611d1b7e
BLAKE2b-256 50043d4ca5dd64c51c42af804c1494b0709998d6ea1df15caba5f9e516b7ead0

See more details on using hashes here.

File details

Details for the file EasyVisitors-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: EasyVisitors-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.4

File hashes

Hashes for EasyVisitors-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 804105ef7fff0fb62a432922bcb6d05714e8caa840a77d6b5a14a4be01cfd442
MD5 ab322201d473d344bd618b1fa082eaa0
BLAKE2b-256 47b2ce3c0ba52b7de354245cfe6151706d4dbc901d1292ba3cd7b47b4f995847

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page