https://github.com/psincraian/pepy

pepy is a site to get statistics information about any Python package.
https://github.com/psincraian/pepy

flask hacktoberfest mit pip python3 website

Last synced: about 2 months ago
JSON representation

pepy is a site to get statistics information about any Python package.

• Host: GitHub
• URL: https://github.com/psincraian/pepy
• Owner: psincraian
• License: mit
• Created: 2018-05-27T19:40:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T05:27:55.000Z (4 months ago)
• Last Synced: 2024-05-21T06:39:49.784Z (4 months ago)
• Topics: flask, hacktoberfest, mit, pip, python3, website
• Language: Python
• Homepage: https://pepy.tech
• Size: 1.61 MB
• Stars: 761
• Watchers: 5
• Forks: 32
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



PePy


## 📜 About

[pepy.tech](https://pepy.tech) is a site which aims to show statistics about Python packages.

This is the repository for the backend service, if you want to check the frontend check this repo https://github.com/psincraian/pepy-front

## 💖 Sponsors

We can keep alive the website thanks to you and also thanks to the following sponsors.

[![DigitalOcean Referral Badge](https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%202.svg)](https://www.digitalocean.com/?refcode=7bf782110d6c&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)



## ⚒️ Start contributing

I wanted to make the setup of the environment as easy as possible. To start the environment you need the 

following prerequisites:

### Prerequisites

  * bash (+4.3)

  * docker (+17.05)

  * docker-compose (+1.16.1)

  * docker-py (+2.2.1)

  * ansible (+2.3)

  

### Start environment

You only (_fingers crossed_) need to execute the following to start the environment:

```commandline

make start-containers

```

## Architecture and patterns

Principally I used some DDD concepts (like value objects, entities, and so on) and also CQS whose objective is to

separate commands from queries.

The structure of the code is the following:

  * `pepy/application`: here is where all the commands and the queries are located.

  * `pepy/domain`: domain objects like entities, exceptions, and value objects.

  * `pepy/infrastructure`: infrastructure components like the implementation of the repository

    class like DB or BigQuery, the Flask web application, the container, and so on.

    * `pepy/infrastructure/cli`: the command line programs.

    * `pepy/infrastructure/container`: config files and the dependency injection manager.

    * `pepy/infrastructure/api`: the api endpoints controller.

    

## FAQ

**Where the downloads come from?**

The data is retrieved from the official BigQuery repository: https://packaging.python.org/guides/analyzing-pypi-package-downloads/

**When the data is updated?**

There is a cron that runs every day at 5 pm UTC that retrieves all the new downloads from the previous day.

## 🚩 License

The code is available under the [MIT license](LICENSE.md).