Commit graph

26 commits

Author SHA1 Message Date
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
Tobias Pflug
47d9dfa46a Provide API documentation in README
This provides a more complete API documetnation covering the public
interface of poetry2nix
2020-02-26 10:15:49 +01:00
Tobias Pflug
c7ebae74a1 Update README
- Add info on mkPoetryApplication
- Add info on mkPoetryEnv
- Add info about manylinux
2019-12-17 21:16:28 +01:00