Comments (3)
In particular I think you need to explicitly state that poetry is a replacement for setup.py. And you need to mention that the command poetry install
replaces pip install -e.
from floodlight.
@kanishkan91 we have instructions for installation in dev mode both in the CONTRIBUTING.md (short version) as well as the extended contributing guide (long version), both explaining the installation of poetry
. I see that for users familiar with setup.py, this might be a bit confusing. I've altered the descriptions in both files at the appropriate places as follows:
- CONTRIBUTING.md: "We use poetry for development and dependency management, which is based on the static
pyproject.toml
file and replacessetup.py
. With poetry, setting up your local dev environment is rather straightforward: [...]" - Contributing Guide: "[...] Luckily, there's a tool called poetry which simplifies this a lot. poetry works with the static
pyproject.toml
file containing project metadata, and replaces the usage ofsetup.py
files. Thus, the first step is to install poetry! [...]"
from floodlight.
Looks great. Thanks for the additions!
from floodlight.
Related Issues (14)
- [BUG] `Poetry install` commend raises error for `h5py` HOT 3
- [FEAT] Add a pressure model HOT 6
- [DOCS] Tracab Data Documentation HOT 3
- [FEAT] Update StatsBomb Parser
- First Release - First Issue! Whats next... HOT 3
- JOSS review: No setup.py? HOT 3
- JOSS review: What is the license associated with this? Considering adding a BSD2 clause license file indicating this is open source HOT 1
- JOSS review: Add explicit link to documentation here (See attached image) HOT 2
- JOSS review: Considering switching documentation to another branch . Something like gh-pages HOT 2
- JOSS review: Some inconsistency with pip version and github version, documented version of floodlight
- JOSS review: Recommend adding coverage to toml file HOT 5
- JOSS review: Comment on low test coverage for datasets.py? HOT 2
- JOSS review: Descriptions, metadata for datasets HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from floodlight.