linkedin / linkedin/shiv

Ignore files while archiving the source code

Open
#103 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
114
PR merge metrics
No merged PRs in 30d

Description

Since python 3.7, zipapp are able to filter particular pattern files.
It is useful for a larger project, which may content different kinds of ignore files.
I propose shiv can support both of the following way to filter out the ignore files.
1. Use filter function like 3.7 does
```
create_archive(APP_APTH, APP_NAME, SHEBANG, MAIN, FILTER_FUNCTION, COMPRESS?)
```
2. Use .pyzignore, like .gitignore, to define the filter pattern.
They can be applied at the same time.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the create_archive entry point referenced in the issue and review how shiv currently builds source archives. Clarify whether both a Python 3.7-style filter function and a .pyzignore pattern file are required, then define tests showing that matching files are excluded and both filters can be applied together.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.