Skip to content
This repository has been archived by the owner on Mar 7, 2022. It is now read-only.

kpostekk/pipenv-publisher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pipenv publisher

Pipenv integration for setuptools.

Install

From pypi

pipenv install pipenv-publisher

From git

pipenv install https://github.com/kpostekk/pipenv-publisher.git#egg=publisher

Initialise in your project

pipenv-pub setuptools setup

That will copy ✨special✨ setup.py in your project directory, add missing declarations to the Pipfile and do lock.

After this, remember to update package's meta in Pipfile!

Usage

Sync version

pipenv-pub stamp . # or pipenv run stamp 

You can replace dot with package name

Remember to add this into your __init__.py

from mypkg._version import __version__, __author__

Tip: in PyCharm you can enable file watcher to automate this task.

Lock before build

pipenv-pub setuptools lock # or pipenv run pub setuptools lock 

FAQ

  • Where I should define all setuptools's stuff?
    • In setup section of pipfile
  • How about my README.md or README.rst, where I should declare it?
    • Nowhere! It's magiaclly detected and added to setuptools.
  • What is setup-lock.json
    • This a file with, peresistent lock of section setup from Pipfile. It has all configuration for setup.py, including install_requires. It shouldn't be in .gitignore
  • Can I still use setup.cfg
    • Yes.
  • Why does it exist?
    • Because I can and there isn't any good tool to integrate setuptools and Pipenv.
  • Examples?
    • This repo is an example lmao.