feat: python projects #514

Chriscbr · 2021-01-24T10:33:28Z

Closes #359

Introduces a new python project type which can be created via npx projen new python. See docs/python.md for more information.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Chriscbr

I wanted to also have some kind of task that would activate the virtual environment in the developer's shell, but tasks currently just run in a child process IIRC so it's yet not possible to do that. But I don't think it's strictly needed for a MVP.

src/__tests__/__snapshots__/new.test.ts.snap

src/python/requirements-file.ts

src/python/python-project.ts

codecov-io · 2021-02-01T00:49:05Z

Codecov Report

Merging #514 (39cbbcc) into master (16a3c45) will increase coverage by 1.18%.
The diff coverage is 81.94%.

@@            Coverage Diff             @@
##           master     #514      +/-   ##
==========================================
+ Coverage   76.65%   77.83%   +1.18%     
==========================================
  Files          75       86      +11     
  Lines        2831     3091     +260     
  Branches      732      779      +47     
==========================================
+ Hits         2170     2406     +236     
- Misses        658      684      +26     
+ Partials        3        1       -2

Impacted Files	Coverage Δ
src/jsii-project.ts	`85.91% <60.00%> (+10.91%)`	⬆️
src/python/venv.ts	`64.70% <64.70%> (ø)`
src/python/requirements-file.ts	`68.00% <68.00%> (ø)`
src/python/poetry.ts	`75.00% <75.00%> (ø)`
src/publisher.ts	`77.77% <77.77%> (ø)`
src/node-project.ts	`74.60% <80.00%> (+0.27%)`	⬆️
src/python/python-project.ts	`81.03% <81.03%> (ø)`
src/python/pip.ts	`88.88% <88.88%> (ø)`
src/index.ts	`100.00% <100.00%> (ø)`
src/python/index.ts	`100.00% <100.00%> (ø)`
... and 21 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e74ee65...39cbbcc. Read the comment docs.

eladb

Looks great!

Feels like we should find a more robust pattern for "toolchain selection". It's a repeating pattern and maybe we can do better than a set of hard-coded booleans (which is what we've done so far, I know...)

I'll try to sketch something and share.

docs/python.md

eladb · 2021-02-01T07:43:00Z

docs/python.md

+```
+
+> At this point, projenrc is in JavaScript, but in the future we plan to allow
+> specifying your project definitions in python.


yass sooner rather then later. happy to help out with that

docs/python.md

src/python/pip.ts

src/python/python-deps.ts

src/python/python-project.ts

src/python/requirements-file.ts

Chriscbr · 2021-02-01T23:10:11Z

Feels like we should find a more robust pattern for "toolchain selection". It's a repeating pattern and maybe we can do better than a set of hard-coded booleans (which is what we've done so far, I know...)

I'll try to sketch something and share.

Cool, I'm totally down. 👍

src/python/python-project.ts

eladb

Looks good. See minor comment.

src/cli/macros.ts

src/python/poetry.ts

src/python/python-project.ts

Chriscbr · 2021-02-04T07:26:20Z

Updated the docs and PR description.

cc @garnaat Feel free to take a look. The docs rendered here give an overview of what we have so far.

There are still some high level features like github workflows and configuration through projenrc.py left, but I'll leave those for a later PR.

I think the mental model I've captured here for several of the python tools is a good enough start, but like @eladb mentioned, there might be a better way to structure the APIs for choosing between these tools.

As far as what the components actually do under the hood, most of it I feel OK with, although I wonder if Pip should be doing more -- like perhaps freezing the requirements and automatically diff'ing the results with the previous version and showing the changes to the user etc. But I don't have much python dependency management experience to build off of, so I'm mostly reading docs online to see what the options are. I just know we want the different language project types to feel similar to use.

Anyway, I'm looking forward to having this merged. :D

Closes projen#359 Introduces a new python project type which can be created via `npx projen new python`. See docs/python.md for more information. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Chriscbr added 9 commits January 23, 2021 03:03

feat: python project

b147e95

add unit test

9fefeff

add more tests

145a509

add some tasks

85fcc85

add docs, addEnvTask

a02ae10

add sample files

27e7621

Add rest of sample files

d8a57d9

simplify error msg

6a3e227

add some docs

5b9e820

Chriscbr commented Jan 24, 2021

View reviewed changes

src/__tests__/__snapshots__/new.test.ts.snap Outdated Show resolved Hide resolved

src/python/requirements-file.ts Outdated Show resolved Hide resolved

src/python/python-project.ts Show resolved Hide resolved

src/python/python-project.ts Outdated Show resolved Hide resolved

Chriscbr added 8 commits January 25, 2021 01:28

add docs, refactor a bunch of things

af1390b

cleanup

e312744

Merge branch 'master' into feat/python-project

e3c9a38

add initial setuptools support

13dfe3f

fix bug

266fd6b

Merge branch 'master' into feat/python-project

c9bcfe3

building out poetry component

cb7510e

poetry env and deps basics working

13f658c

fix test task not working

ddd8717

eladb suggested changes Feb 1, 2021

View reviewed changes

commit suggestions to docs/python.md

e7771cd

Chriscbr added 2 commits February 1, 2021 19:24

add docs and incorporate other feedback

335b1a3

add proper packaging and uploading support for poetry

3bf98b1

Chriscbr commented Feb 2, 2021

View reviewed changes

src/python/python-project.ts Outdated Show resolved Hide resolved

Chriscbr added 4 commits February 1, 2021 21:48

update docs and some unit tests

02156eb

Merge branch 'master' into feat/python-project

8050ef4

remove pythonPath option

0a6ee72

combine packaging options into a single interface

729a967

Chriscbr added 2 commits February 3, 2021 03:41

fix docs

d33ae44

revert change to new.test.ts

39cbbcc

eladb reviewed Feb 3, 2021

View reviewed changes

src/cli/macros.ts Outdated Show resolved Hide resolved

src/python/poetry.ts Outdated Show resolved Hide resolved

src/python/python-project.ts Show resolved Hide resolved

Base automatically changed from master to main February 3, 2021 14:45

Chriscbr added 5 commits February 4, 2021 01:23

resolve comments

16ace94

add a pytest option as an example

6fd9899

bug fix so users don't have to specify description

f327f52

remove references to pythonpath

2a0bd5b

more docs edits

c8fbe27

eladb approved these changes Feb 4, 2021

View reviewed changes

Merge branch 'main' into feat/python-project

d226bb3

mergify bot merged commit bf6b6af into projen:main Feb 4, 2021

myles2007 mentioned this pull request Sep 6, 2023

Poetry install task updates project dependencies #2913

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: python projects #514

feat: python projects #514

Chriscbr commented Jan 24, 2021 •

edited

Loading

Chriscbr left a comment

codecov-io commented Feb 1, 2021 •

edited

Loading

eladb left a comment

eladb Feb 1, 2021

Chriscbr commented Feb 1, 2021

eladb left a comment

Chriscbr commented Feb 4, 2021

feat: python projects #514

feat: python projects #514

Conversation

Chriscbr commented Jan 24, 2021 • edited Loading

Chriscbr left a comment

Choose a reason for hiding this comment

codecov-io commented Feb 1, 2021 • edited Loading

Codecov Report

eladb left a comment

Choose a reason for hiding this comment

eladb Feb 1, 2021

Choose a reason for hiding this comment

Chriscbr commented Feb 1, 2021

eladb left a comment

Choose a reason for hiding this comment

Chriscbr commented Feb 4, 2021

Chriscbr commented Jan 24, 2021 •

edited

Loading

codecov-io commented Feb 1, 2021 •

edited

Loading