Victor Engmark
e40f2180c0
feat: Print unified diff between sorted and unsorted JSON
...
Easier to read, and can be piped directly into `patch -p0`.
2023-09-26 12:52:16 +13:00
Victor Engmark
60d1fd4fdc
docs: Fix internal links
...
It seems GitHub generates all-lowercase heading anchors.
2023-07-19 11:32:02 +12:00
asymmetric
215afa14f7
FAQ: Clarify poetry2nix does not use nixpkgs for Python packages ( #1193 )
...
* FAQ: Clarify poetry2nix does not use nixpkgs for Python packages
* Improve answer based on @takeda's feedback
2023-07-02 00:58:30 +12:00
Victor Engmark
abe5083ba8
docs: Avoid nested list of overrides
...
As far as I can tell, `defaultPoetryOverrides` is already a list.
2023-06-09 15:48:39 +12:00
Hung Tran
5f915f9500
+docs: build binary with mkPoetryApplication and build webserver wrapper binary
2023-03-14 15:55:21 -07:00
adisbladis
b5fa4810df
Merge pull request #987 from l0b0/docs/testing-commands
...
docs: Testing commands
2023-02-27 14:42:28 +13:00
Victor Engmark
0b0b83c7d0
docs: Explain how to test with a specific channel
2023-02-14 15:29:06 +13:00
Victor Engmark
752e83ae10
docs: Explain how to run specific tests
2023-02-14 15:27:50 +13:00
Victor Engmark
74a2521ab1
docs: Explain how to list tests
2023-02-14 14:40:44 +13:00
Jairo Llopis
c1de037f1b
docs: document how to override preferWheel = true
...
This commit also fixes the previous one's test.
2023-01-26 10:00:13 +00:00
Lorenzo Manacorda
c34428e242
doc: Document build priority
2022-12-26 18:41:12 +01:00
Lorenzo Manacorda
042e42759d
doc: fix poetry homepage
2022-12-26 18:41:01 +01:00
Phillip Cloud
0993932240
docs: add bits to the README about extras parameter
2022-12-20 10:21:00 -05:00
Andreas Zweili
9090d8fafb
Add an FAQ section to the README
2022-11-19 23:53:10 +01:00
adisbladis
2081943793
Add support for Poetry >=1.2.0 dependency groups
2022-09-22 16:23:08 +12:00
Ryan Lahfa
c13ba70208
Document preferWheels parameter
...
I realize that people do not know of `preferWheels` and here is a simple attempt to document it.
2022-04-19 00:53:54 +02:00
adisbladis
e6433fee56
overrides.nix: Move into overrides/default.nix
...
I will implement some automation around creating these which will have supplementary files that shouldn't pollute the project root.
2022-01-21 10:19:04 +12:00
adisbladis
a97a37d0b0
Add table of contents to readme
2022-01-06 14:35:01 +13:00
adisbladis
9746602f79
Add a section for how to guides
2022-01-06 14:30:44 +13:00
adisbladis
604e4a4dcf
Create an acknowledgements section in the README
...
And reorder the contact section.
2022-01-06 14:22:32 +13:00
adisbladis
2ce16fd822
README: Document new editablePackageSources behaviour where develop=true
2022-01-06 05:49:43 +13:00
Vincent Bernat
c47ff252c1
README: fix shell example syntax
2022-01-02 23:35:35 +01:00
adisbladis
0985711b0b
mkPoetryEnv: Add an extraPackages argument
...
This is a function taking a Python package set and returning a list of extra packages to include in the environment. This is intended for packages deliberately not added to `pyproject.toml` that you still want to include. An example of such a package may be `pip`.
2021-12-27 16:49:26 -08:00
adisbladis
b7d3526cee
README: Add Matrix room links
2021-12-25 13:58:56 -08:00
Steve Purcell
62b1ec8cc9
Update attribution and copyright to reflect Tweag's support
2021-11-26 18:56:41 +01:00
ryneeverett
cd659414ca
README: recommend overriding env over mkShell
...
Resolve #186 .
The current documentation shows how to include dev-dependencies in
environment *or* add external dependencies to the environment, but I
suspect in the vast majority of cases both will be desired.
2021-09-27 12:48:29 -04:00
Vince
ee6dd0496d
Remove repeated section
2021-09-02 14:11:45 +02:00
Daniel Fullmer
cbf4157014
Fix instructions to init a flake using the template
2021-08-26 16:03:15 -07:00
adisbladis
35017baff2
Merge pull request #289 from FRidh/template
...
Provide flake template for building an app
2021-08-12 09:51:16 -05:00
sireliah
74d233de97
Correct the nix format typo
2021-05-27 10:58:34 +02:00
Frederik Rietdijk
9c90be6a1d
Provide flake template for building an app
...
Provide a basic flake template for building a Python application.
2021-04-25 10:48:46 +02:00
sireliah
3cca68e31e
Document how to run tests locally
2021-03-12 12:56:53 +01:00
Joshua Skrzypek
a2bd638ff8
Expose functions for editable & scripts packages
...
The editablePackage and scriptsPackage elements of the mkPoetryEnv
function are wholly separable and really ought to be moved into the
functionality of the mkPoetryPackages function. By doing so both will
automatically be available in the mkPoetryApplication's dependencyEnv as
well.
I thought the functionality that encapsulates these might further see
potential use even outside the context of mkPoetryPackages, so I made
them top-level functions and documented them in the README.
2021-01-15 12:06:29 -05:00
Kyle Gentle
2caeb26814
add missing pkgs prefix to examples
2020-12-13 13:39:11 -05:00
Kyle Gentle
f70ffaa7ef
Add mkPoetryEnv shell.nix examples to README
...
It took me a while to figure this out, so I think it may be useful to add as a reference to future `poetry2nix` users.
Related to and inspired by #186 , #60 .
2020-12-13 12:44:27 -05:00
Eric Wolf
1c7e2dfe29
Adjust the README.md and provide a usage example
2020-11-22 09:38:17 +01:00
Greizgh
f8fef60b8d
fix anchor in readme
2020-09-05 18:35:18 +02:00
adisbladis
e5ddd73773
Add example showing how to use overrideScope' as a nixpkgs overlay
2020-07-22 01:21:24 +02:00
adisbladis
e195d917f9
Add composable defaults to README
2020-07-22 01:21:24 +02:00
Raphael Das Gupta
267c6724e0
fix markup of inline code
2020-06-30 13:55:47 +02:00
Silvan Mosberger
6f1b89756c
Extend docs for editablePackageSources
2020-05-08 23:01:13 +01:00
Silvan Mosberger
a371e771f1
Add docs for dependencyEnv passthru
2020-05-08 22:11:55 +02:00
adisbladis
10b7ceccb6
Remove reference to gitlab ci from badge link
2020-04-15 16:24:18 +01:00
adisbladis
9e89365acb
Update badge URL to use Github Actions
2020-04-15 16:18:18 +01:00
adisbladis
d5be1a8bb8
README: Add missing semicolon
2020-03-27 23:16:11 +00:00
adisbladis
81a24d4d19
Fix README formatting
2020-02-29 22:06:11 +00:00
adisbladis
924746ff9a
Make gitignore recursive
2020-02-29 21:22:34 +00:00
adisbladis
bb3c2d57d5
Add a default source filter when projectDir is used
...
Also use the same source filter for path deps.
The default source filter currently filters:
- Filters gitignore (if it exists, non-recursive)
- Filters pycache/pyc files
- Uses cleanSourceFilter to filter out .git/.hg, .o/.so, editor backup files & nix result symlinks
2020-02-29 12:05:23 +00:00
adisbladis
4e48f6c851
Clarify that attrs passed to mkPoetryApplication are passed through to buildPythonApplication
2020-02-29 12:04:36 +00:00
adisbladis
b85e2a6733
Set src to lib.cleanSource projectDir by default
...
Ideally we'd use `nix-gitignore` but that one fails when there is no
`.gitignore` file so it's not a sensible default.
2020-02-29 12:04:36 +00:00
