lincc-frameworks / lincc-frameworks/python-project-template

Adopt the template for applications

Aberta
#556 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Jinja
Estrelas
85
Forks
16
Merge médio
6h 18min
PRs com merge (30d)
1

Descrição

Currently, the template is really focused on libraries, not on end-user software, such as ML or data analysis pipelines, web portals, scripts, etc. Researchers are more frequently starting a new end-user project than a library.

There are usually different expectations from end-user software than from a library: the environment should be reproducible, e.g., require some sort of a lock file; package data setup may be required; Dockerfile or entry points usually should be set up. I think the next "big thing" for PPT may be support for projects like that, while we can use in-house end-user projects to test it, e.g., hyrax (which, of course, is a library, but also a user-level script), hats-import scripts, "cone search v2.0", and individual team members' projects (I'd be happy to test it with uncle-val).

I propose to use `uv` for the lock file and tooling support, which makes it easy to manage virtual environments and gives a consistent way of running Python tools and commands via, e.g., `uv run pytest` and `uv run python -m my-module`.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece examinando o template atual focado em bibliotecas e os fluxos de trabalho dos usuários finais mencionados na issue, incluindo hyrax e hats-import. Avalie como os arquivos de lock gerenciados pelo uv, os ambientes reproduzíveis, a configuração dos dados do pacote, o suporte a Dockerfile e os entry points devem se encaixar; considera-se concluído quando houver um design de template acordado para esses projetos de aplicação.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
build-system, tooling
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
30/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.