https://github.com/briefmnews/python-package-server
This is the PyPI server of Brief.me
https://github.com/briefmnews/python-package-server
Last synced: 3 months ago
JSON representation
This is the PyPI server of Brief.me
- Host: GitHub
- URL: https://github.com/briefmnews/python-package-server
- Owner: briefmnews
- Created: 2019-05-07T08:50:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T08:59:40.000Z (8 months ago)
- Last Synced: 2024-10-29T10:07:08.268Z (8 months ago)
- Language: HTML
- Homepage: https://briefmnews.github.io/python-package-server/
- Size: 482 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Brief.me PyPI server
====================
This is the PyPI server of Brief.me
## How to add a new release with the make command?
You can use the following make command to create a new app release:
```bash
make bump app=marketing-blocks version=0.1
```
The 2 parameters `app` and `version` are optional. If not set, the terminal will prompt you to fill them.
## How to add a new release without the make command?
Adding a new release for an existing app is a 4 steps process.
### 1. Update the version number in the setup.py
Here is an example for the release `0.1` for the marketing-blocks app:
```python
from setuptools import setup
setup(
name='marketing-blocks',
version='0.1',
...,
)
```
### 2. Create a new release
### 3. Add the new release to python-package-server
When the release is published you can add it the `python-package-sever` app.
Here is an example for the release `0.1` of the marketing-blocks app:
```html
Marketing Blocks
marketing-blocks-0.1
marketing-blocks-0.0.1
```
### 4. Commit your changes
Here is an example of commit:
```shell
git commit -m "feat(marketing-blocks): release version 0.1"
```
Our private PyPI server is hosted by github pages.
The deployment process might take up to 5 minutes.
## How to use?
Let's take the django app `marketing-blocks` as example.
In order to add the release `0.1` of `marketing-blocks` to one of your existing project,
you need to add the following to your `requirements.py`:
```shell
--extra-index-url https://briefmnews.github.io/python-package-server/
marketing-blocks==0.1
Django==2.2.24
...
```
In this situation, pip will try to find indexes from https://briefmnews.github.io/python-package-server/ before the official PyPI server.