Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: team-12-csc-510
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 20.7 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 3
Created over 3 years ago · Last pushed over 3 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

adilytics

example branch parameter PyPI - License Made By codecov DOI Issues_Open Issues_Closed

Logo

Project 1: Perform the advertisement analytics on a platform and visualise the results.

Team 12's submission for Project 1 for CSC-510.

Here is a quick introduction video:

https://user-images.githubusercontent.com/112341004/194640685-1cfeffa0-c33c-4c2f-b2c5-de64d47c637a.mp4

Table Of Contents


Installation

Requires Python v3.9+. Clone the repository and move into the project directory and install the project dependencies.

To install the dependencies/packages required for the project install Poetry

shell curl https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python3 -

To get started you need Poetry's bin directory (/Users/<username>/Library/Python/python-version/bin) in your PATH environment variable.

Refer here for configuring poetry path correctly.

You can test that everything is set up by executing:

shell poetry --version

Configure Poetry virtual environment by

shell poetry env use python3 poetry install


License

This project is licensed under MIT license available in LICENSE file


Tools

**Fast Api**

This project makes use of FAST API. You can refer to the link to learn more about its working FAST API .

FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints.

Some key features are:

  • Fast: Very high performance, on par with NodeJS and Go (thanks to Starlette and Pydantic). One of the fastest Python frameworks available.
  • Fast to code: Increase the speed to develop features by about 200% to 300%.
  • Fewer bugs: Reduce about 40% of human (developer) induced errors.
  • Standards-based: Based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.
**Locust**

This project makes use of Locust. You can refer to the link to learn more about its working Locust.

Locust is used to run load tests distributed over multiple machines. It is event-based (using gevent), which makes it possible for a single process to handle many thousands concurrent users. While there alternatives capable of doing more requests per second on a given hardware, the low overhead of each Locust user makes it very suitable for testing highly concurrent workloads.

How to run Locust script in the project

Run the scripts in the following order:

  1. product_creation.py
  2. ad_creation.py
  3. user_simulation.py

To run productcreation.py: locust -f productcreation.py --headless -H http://127.0.0.1:8000 -u 1 -r 1

Run this script with just one thread to create 50 products (-u 1 -r 1)

To run adcreation.py: locust -f adcreation.py --headless -H http://127.0.0.1:8000 -u 50 -r 50

Run this script with as many number of threads as you want to create ads.

To run usersimulation.py: locust -f usersimulation.py --headless -H http://127.0.0.1:8000 -u 50 -r 50 .

Run this script with as many number of threads as you want to simulate users.


Team

Name | Unity id ------------- | ------------- Aditya Tewari | adtewari Naman Bhagat | nbhagat2 Ritwik Tiwari | rtiwari2 Saksham Thakur | sthakur5 Shubhender Singh | ssingh54


Group Communication WhatsApp Chat


Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Tewari"
  given-names: "Aditya"
- family-names: "Bhagat"
  given-names: "Naman"
- family-names: "Tiwari"
  given-names: "Ritwik"
- family-names: "Thakur"
  given-names: "Saksham"
- family-names: "Singh"
  given-names: "Shubhender"

title: "CSC 510- Project 1 (Adilytics)"
version: 1.0.0
doi: 10.5281/zenodo.7032659
date-released: 2022-10-07
url: "https://github.com/team-12-csc-510/adilytics"

GitHub Events

Total
Last Year

Dependencies

poetry.lock pypi
  • PyYAML 6.0 develop
  • attrs 22.1.0 develop
  • black 22.8.0 develop
  • cfgv 3.3.1 develop
  • distlib 0.3.6 develop
  • filelock 3.8.0 develop
  • flake8 5.0.4 develop
  • identify 2.5.5 develop
  • iniconfig 1.1.1 develop
  • isort 5.10.1 develop
  • mccabe 0.7.0 develop
  • mypy 0.971 develop
  • mypy-extensions 0.4.3 develop
  • nodeenv 1.7.0 develop
  • packaging 21.3 develop
  • pathspec 0.10.1 develop
  • platformdirs 2.5.2 develop
  • pluggy 1.0.0 develop
  • pre-commit 2.20.0 develop
  • py 1.11.0 develop
  • pycodestyle 2.9.1 develop
  • pyflakes 2.5.0 develop
  • pyparsing 3.0.9 develop
  • pytest 7.1.3 develop
  • setuptools 65.3.0 develop
  • toml 0.10.2 develop
  • tomli 2.0.1 develop
  • virtualenv 20.16.5 develop
  • anyio 3.6.1
  • click 8.1.3
  • colorama 0.4.5
  • dnspython 2.2.1
  • fastapi 0.85.0
  • h11 0.13.0
  • idna 3.4
  • motor 3.0.0
  • pydantic 1.10.2
  • pymongo 4.2.0
  • python-dotenv 0.21.0
  • sniffio 1.3.0
  • starlette 0.20.4
  • typing-extensions 4.3.0
  • uvicorn 0.18.3
pyproject.toml pypi
  • black ^22.6.0 develop
  • flake8 ^5.0.4 develop
  • isort ^5.10.0 develop
  • mypy ^0.971 develop
  • pre-commit ^2.20.0 develop
  • pytest ^7.1.0 develop
  • dnspython ^2.2.1
  • fastapi ^0.85.0
  • motor ^3.0.0
  • pymongo ^4.2.0
  • python ^3.9
  • python-dotenv ^0.21.0
  • uvicorn ^0.18.3
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite