lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Jinja
- Star
- 85
- Fork
- 16
- Merge trung bình
- 6 giờ 18 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
Add question for adding a command line interface
Will add to the pyproject.toml:
[project.scripts]
hyrax = "hyrax_cli.main:main"
Create some CLI entry point
- e.g. /src/hyrax_cli/main.py
- has all of the bits for a main method, and basic argparsing (and version printing).
Additional documentation:
- how to make a CLI for do_thing input_file output_file
- how to create config files, to trim the number of CLI arguments.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với pyproject.toml của template và entry point được đề xuất src/hyrax_cli/main.py. Thêm console script hyrax, phân tích đối số cơ bản, in phiên bản và tài liệu cho CLI do_thing input_file output_file cùng các tệp cấu hình. Công việc được xem là hoàn tất khi project được tạo ra cung cấp một CLI hoạt động được và giải thích cách sử dụng cũng như cấu hình CLI đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- cli, documentation
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100