├── src ├── main.rs └── lib.rs ├── .gitignore ├── tests ├── basic.rs └── README.md ├── benches ├── example_bench.rs └── README.md ├── rust-toolchain.toml ├── .github ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── question.yml │ ├── feature-request.yml │ └── bug-report.yml ├── dependabot.yml └── workflows │ ├── ci.yml │ ├── format.yml │ └── publish.yml ├── Cargo.toml ├── rustfmt.toml ├── docs └── README.md ├── README.md └── LICENSE /src/main.rs: -------------------------------------------------------------------------------- 1 | // Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | use ultralytics_template_rust::run_example; 4 | 5 | fn main() { 6 | println!("{}", run_example()); 7 | } 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Build artifacts 2 | /target 3 | 4 | # Cargo 5 | .cargo/ 6 | Cargo.lock 7 | 8 | # Editor files 9 | .idea/ 10 | .vscode/ 11 | 12 | # OS cruft 13 | .DS_Store 14 | Thumbs.db 15 | 16 | # Coverage and tooling output 17 | coverage/ 18 | *.profraw 19 | *.profdata 20 | llvm-cov-report/ 21 | 22 | # Logs 23 | *.log 24 | 25 | # Benchmark results 26 | /target/criterion/ 27 | 28 | # Cargo deny cache 29 | .cargo-deny/ 30 | -------------------------------------------------------------------------------- /tests/basic.rs: -------------------------------------------------------------------------------- 1 | // Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | use ultralytics_template_rust::{add_numbers, run_example}; 4 | 5 | #[test] 6 | fn add_numbers_handles_signed_values() { 7 | assert_eq!(add_numbers(2, 3), 5); 8 | assert_eq!(add_numbers(-1, 1), 0); 9 | assert_eq!(add_numbers(-1, -1), -2); 10 | } 11 | 12 | #[test] 13 | fn example_output_matches_cli() { 14 | assert_eq!(run_example(), "Added 1 + 2 = 3"); 15 | } 16 | -------------------------------------------------------------------------------- /benches/example_bench.rs: -------------------------------------------------------------------------------- 1 | // Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | use criterion::{Criterion, black_box, criterion_group, criterion_main}; 4 | use ultralytics_template_rust::add_numbers; 5 | 6 | fn benchmark_add_numbers(c: &mut Criterion) { 7 | c.bench_function("add_numbers", |b| { 8 | b.iter(|| add_numbers(black_box(100), black_box(200))) 9 | }); 10 | } 11 | 12 | criterion_group!(benches, benchmark_add_numbers); 13 | criterion_main!(benches); 14 | -------------------------------------------------------------------------------- /rust-toolchain.toml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | # Rust toolchain specification 4 | # See https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file 5 | # Using nightly to support unstable rustfmt features in rustfmt.toml 6 | 7 | [toolchain] 8 | channel = "nightly" 9 | components = ["rustfmt", "clippy", "rust-src", "rust-analyzer"] 10 | targets = ["x86_64-unknown-linux-gnu", "x86_64-apple-darwin", "aarch64-apple-darwin", "x86_64-pc-windows-msvc", "aarch64-pc-windows-msvc"] 11 | profile = "default" 12 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | blank_issues_enabled: true 4 | contact_links: 5 | - name: 📄 Docs 6 | url: https://docs.ultralytics.com/ 7 | about: Full Ultralytics Documentation 8 | - name: 💬 Forum 9 | url: https://community.ultralytics.com/ 10 | about: Ask on Ultralytics Community Forum 11 | - name: 🎧 Discord 12 | url: https://ultralytics.com/discord 13 | about: Ask on Ultralytics Discord 14 | - name: ⌨️ Reddit 15 | url: https://reddit.com/r/ultralytics 16 | about: Ask on Ultralytics Subreddit 17 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | # Dependabot for package version updates 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: cargo 9 | directory: "/" 10 | schedule: 11 | interval: weekly 12 | time: "04:00" 13 | open-pull-requests-limit: 10 14 | labels: 15 | - dependencies 16 | 17 | - package-ecosystem: github-actions 18 | directory: "/.github/workflows" 19 | schedule: 20 | interval: weekly 21 | time: "04:00" 22 | open-pull-requests-limit: 5 23 | labels: 24 | - dependencies 25 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | [package] 4 | name = "ultralytics-template-rust" 5 | version = "0.0.5" 6 | edition = "2024" # use the latest stable edition for new projects 7 | license = "AGPL-3.0-or-later" 8 | description = "Ultralytics Rust project template showcasing a minimal library and binary layout." 9 | repository = "https://github.com/ultralytics/template-rust" 10 | homepage = "https://www.ultralytics.com/" 11 | documentation = "https://docs.ultralytics.com" 12 | readme = "README.md" 13 | rust-version = "1.91" # edition 2024 requires Rust >= 1.85; pin to a current stable for CI 14 | keywords = ["ultralytics", "template", "ml", "ai", "yolo"] 15 | categories = ["development-tools", "science", "computer-vision"] 16 | 17 | [dependencies] 18 | 19 | [dev-dependencies] 20 | criterion = { version = "0.5", features = ["html_reports"] } 21 | 22 | [[bench]] 23 | name = "example_bench" 24 | harness = false 25 | -------------------------------------------------------------------------------- /rustfmt.toml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | # Configuration for https://rust-lang.github.io/rustfmt/ 4 | edition = "2024" 5 | 6 | # Enable unstable features (requires nightly) 7 | unstable_features = true 8 | 9 | # E.g. Foo { a, b, c } 10 | use_field_init_shorthand = true 11 | 12 | # Unstable options. These require a nightly compiler to use (cargo +nightly fmt). 13 | 14 | # We choose a wider comment width, as this tends to make comments more readable than truncating at 15 | # 80 characters. 16 | wrap_comments = true 17 | comment_width = 120 18 | format_code_in_doc_comments = true 19 | 20 | # `#[doc = "..."]` -> `/// ...` 21 | normalize_doc_attributes = true 22 | 23 | # We choose module granularity for imports as this tends to have the best balance between low 24 | # linecount while making it simple to understand diffs 25 | group_imports = "StdExternalCrate" 26 | imports_granularity = "Module" 27 | 28 | format_macro_matchers = true 29 | -------------------------------------------------------------------------------- /tests/README.md: -------------------------------------------------------------------------------- 1 | Ultralytics logo 2 | 3 | # Tests Directory (`tests/`) 4 | 5 | This directory contains Rust integration tests for the Ultralytics template crate. Keeping tests close to user-facing 6 | behaviors helps ensure changes remain reliable and well-documented. 7 | 8 | ## 🧪 Overview 9 | 10 | - Uses standard [Cargo tests](https://doc.rust-lang.org/cargo/guide/tests.html) with Rust’s built-in test harness. 11 | - Organized to mirror the structure of the source code directory for easy navigation and reference. 12 | - Tests should be comprehensive, covering user-facing behavior, error handling, and edge cases. 13 | 14 | ## 🚀 Running Tests 15 | 16 | Run the full suite from the project root: 17 | 18 | ```bash 19 | cargo test 20 | ``` 21 | 22 | To generate code coverage locally (Linux recommended): 23 | 24 | ```bash 25 | cargo llvm-cov --all-features --workspace --html 26 | ``` 27 | 28 | ## ✨ Contributing 29 | 30 | We love contributions! If you find an issue or have an idea for improving the tests, please open an issue or submit a pull 31 | request. See our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for details. 32 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | name: CI 4 | 5 | permissions: 6 | contents: read 7 | 8 | on: 9 | push: 10 | branches: [main] 11 | pull_request: 12 | branches: [main] 13 | schedule: 14 | - cron: "0 0 * * *" 15 | 16 | jobs: 17 | test: 18 | runs-on: ${{ matrix.os }} 19 | strategy: 20 | fail-fast: false 21 | matrix: 22 | os: [ubuntu-latest, macos-latest, windows-latest] 23 | 24 | steps: 25 | - uses: actions/checkout@v6 26 | 27 | - name: Set up Rust 28 | uses: dtolnay/rust-toolchain@stable 29 | 30 | - name: Cache build artifacts 31 | uses: Swatinem/rust-cache@v2 32 | 33 | - name: Format 34 | run: cargo fmt --all -- --check 35 | 36 | - name: Clippy 37 | run: cargo clippy --all-targets --all-features -- -D warnings 38 | 39 | - name: Tests 40 | run: cargo test --all --all-features 41 | 42 | coverage: 43 | runs-on: ubuntu-latest 44 | needs: test 45 | steps: 46 | - uses: actions/checkout@v6 47 | 48 | - name: Set up Rust 49 | uses: dtolnay/rust-toolchain@stable 50 | 51 | - name: Cache build artifacts 52 | uses: Swatinem/rust-cache@v2 53 | 54 | - name: Install cargo-llvm-cov 55 | uses: taiki-e/install-action@v2 56 | with: 57 | tool: cargo-llvm-cov 58 | 59 | - name: Coverage 60 | run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info 61 | 62 | - name: Upload coverage to Codecov 63 | uses: codecov/codecov-action@v5 64 | with: 65 | files: ./lcov.info 66 | token: ${{ secrets.CODECOV_TOKEN }} 67 | flags: template_coverage 68 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | // Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | use std::ops::Add; 4 | 5 | /// Adds two values together. 6 | /// 7 | /// The function works with any type that supports the `+` operator and is `Copy`, making it usable 8 | /// with common numeric primitives such as integers or floating-point numbers. 9 | /// 10 | /// # Examples 11 | /// ``` 12 | /// use ultralytics_template_rust::add_numbers; 13 | /// 14 | /// let sum = add_numbers(1_i32, 2_i32); 15 | /// assert_eq!(sum, 3); 16 | /// 17 | /// let float_sum = add_numbers(1.5_f64, 2.0_f64); 18 | /// assert!((float_sum - 3.5_f64).abs() < f64::EPSILON); 19 | /// ``` 20 | pub fn add_numbers(a: T, b: T) -> T 21 | where 22 | T: Add + Copy, 23 | { 24 | a + b 25 | } 26 | 27 | /// Generates a human-readable summary of the example addition. 28 | /// 29 | /// This mirrors the simple entry point showcased by the CLI in `src/main.rs` and is exposed so 30 | /// integration tests can validate user-visible behavior without shelling out. 31 | pub fn run_example() -> String { 32 | let a = 1; 33 | let b = 2; 34 | let y = add_numbers(a, b); 35 | format!("Added {a} + {b} = {y}") 36 | } 37 | 38 | #[cfg(test)] 39 | mod tests { 40 | use super::*; 41 | 42 | #[test] 43 | fn adds_integers() { 44 | assert_eq!(add_numbers(2, 3), 5); 45 | assert_eq!(add_numbers(-1, 1), 0); 46 | assert_eq!(add_numbers(-1, -1), -2); 47 | } 48 | 49 | #[test] 50 | fn adds_floats() { 51 | let result = add_numbers(1.5_f32, 2.25_f32); 52 | assert!((result - 3.75_f32).abs() < f32::EPSILON); 53 | } 54 | 55 | #[test] 56 | fn produces_example_output() { 57 | let output = run_example(); 58 | assert_eq!(output, "Added 1 + 2 = 3"); 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /.github/workflows/format.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | # Ultralytics Actions https://github.com/ultralytics/actions 4 | # This workflow formats code and documentation in PRs to Ultralytics standards 5 | 6 | name: Ultralytics Actions 7 | 8 | on: 9 | issues: 10 | types: [opened] 11 | pull_request: 12 | branches: [main] 13 | types: [opened, closed, synchronize, review_requested] 14 | 15 | permissions: 16 | contents: write # Modify code in PRs 17 | pull-requests: write # Add comments and labels to PRs 18 | issues: write # Add comments and labels to issues 19 | 20 | jobs: 21 | actions: 22 | runs-on: ubuntu-latest 23 | steps: 24 | - name: Run Ultralytics Actions 25 | uses: ultralytics/actions@main 26 | with: 27 | token: ${{ secrets._GITHUB_TOKEN || github.token }} # Auto-generated fallback 28 | labels: true # Auto-label issues/PRs using AI 29 | python: true # Format Python with Ruff 30 | prettier: true # Format YAML, JSON, Markdown, CSS 31 | swift: false # Format Swift (requires macos-latest) 32 | spelling: true # Check spelling with codespell 33 | links: true # Check broken links with Lychee 34 | summary: true # Generate AI-powered PR summaries 35 | openai_api_key: ${{ secrets.OPENAI_API_KEY }} # Powers PR summaries, labels and comments 36 | brave_api_key: ${{ secrets.BRAVE_API_KEY }} # Used for broken link resolution 37 | 38 | - name: Checkout repository 39 | uses: actions/checkout@v6 40 | 41 | - name: Set up Rust 42 | uses: dtolnay/rust-toolchain@nightly 43 | with: 44 | components: rustfmt 45 | 46 | - name: Check Rust formatting 47 | run: cargo fmt --all -- --check 48 | -------------------------------------------------------------------------------- /benches/README.md: -------------------------------------------------------------------------------- 1 | Ultralytics logo 2 | 3 | # Benchmarks 4 | 5 | This directory contains performance benchmarks for the project using [Criterion.rs](https://github.com/bheisler/criterion.rs). 6 | 7 | ## Running Benchmarks 8 | 9 | ```bash 10 | # Run all benchmarks 11 | cargo bench 12 | 13 | # Run specific benchmark 14 | cargo bench --bench example_bench 15 | 16 | # Generate detailed report 17 | cargo bench -- --verbose 18 | ``` 19 | 20 | ## Viewing Results 21 | 22 | Benchmark results are stored in `target/criterion/` and include: 23 | 24 | - HTML reports for visualization 25 | - Statistical analysis 26 | - Performance comparison across runs 27 | 28 | Open `target/criterion/report/index.html` in your browser to view detailed results. 29 | 30 | ## Adding New Benchmarks 31 | 32 | Create a new file in this directory following the pattern in `example_bench.rs`: 33 | 34 | ```rust 35 | use criterion::{black_box, criterion_group, criterion_main, Criterion}; 36 | use ultralytics_template_rust::your_function; 37 | 38 | fn benchmark_function(c: &mut Criterion) { 39 | c.bench_function("your_function", |b| { 40 | b.iter(|| your_function(black_box(42))) 41 | }); 42 | } 43 | 44 | criterion_group!(benches, benchmark_function); 45 | criterion_main!(benches); 46 | ``` 47 | 48 | Then register it in `Cargo.toml`: 49 | 50 | ```toml 51 | [[bench]] 52 | name = "your_bench" 53 | harness = false 54 | ``` 55 | 56 | ## Best Practices 57 | 58 | - Use `black_box()` to prevent compiler optimizations from skipping code 59 | - Run benchmarks on a quiet system for accurate results 60 | - Compare benchmarks before and after changes 61 | - Document performance characteristics and trade-offs 62 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | name: ❓ Question 4 | description: Ask an Ultralytics software question 5 | # title: " " 6 | labels: [question] 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Thank you for asking an Ultralytics ❓ Question! 12 | 13 | - type: checkboxes 14 | attributes: 15 | label: Search before asking 16 | description: > 17 | Please search the Ultralytics [Docs](https://docs.ultralytics.com/), [issues](https://github.com/ultralytics/template-rust/issues) and [discussions](https://github.com/orgs/ultralytics/discussions) to see if a similar question already exists. 18 | options: 19 | - label: > 20 | I have searched the Ultralytics [issues](https://github.com/ultralytics/template-rust/issues) and [discussions](https://github.com/orgs/ultralytics/discussions) and found no similar questions. 21 | required: true 22 | 23 | - type: textarea 24 | attributes: 25 | label: Question 26 | description: What is your question? Please provide as much information as possible. Include detailed Rust code examples to reproduce the problem and describe the context in which the issue occurs. Format your text and code using [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for clarity and readability. Following these guidelines will help us assist you more effectively. 27 | placeholder: | 28 | 💡 ProTip! Include as much information as possible (logs, panic messages, screenshots etc.) to receive the most helpful response. 29 | validations: 30 | required: true 31 | 32 | - type: textarea 33 | attributes: 34 | label: Additional 35 | description: Anything else you would like to share? 36 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | Ultralytics logo 2 | 3 | # Documentation Directory (`docs/`) 4 | 5 | This directory contains documentation for the [Ultralytics](https://github.com/ultralytics/ultralytics) Rust template. It 6 | is intentionally lightweight so teams can layer on their preferred tooling without clutter. 7 | 8 | ## 📖 Overview 9 | 10 | - **rustdoc-first:** Inline `///` comments in `src/` power API docs (`cargo doc --open`). 11 | - **Markdown pages:** Expand project guides here using Markdown for quick start notes, architecture decisions, and API 12 | walkthroughs. 13 | - **Optional generators:** Teams can add [mdBook](https://rust-lang.github.io/mdBook/) or `cargo doc` deploy workflows as 14 | needed; keep configs in the repo root to avoid nesting. 15 | 16 | ## 🚀 Getting Started 17 | 18 | To work with the documentation locally: 19 | 20 | 1. **Browse API docs:** `cargo doc --open` renders the crate documentation locally. 21 | 2. **Preview Markdown:** Use your preferred Markdown preview (VS Code, mdBook, or static site generator) to iterate on 22 | guides stored here. 23 | 3. **Ship docs:** If you add mdBook or other tooling, document the commands in this file so contributors know how to 24 | build and deploy the site. 25 | 26 | Update this directory as the Rust code evolves to keep examples aligned and onboarding smooth. 27 | 28 | ## 🙌 Contributing 29 | 30 | Contributions to improve the documentation are welcome! Whether it's fixing typos, clarifying explanations, adding 31 | examples, or translating content, your help is valuable. Please see our 32 | [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for more details on how to get started. You can also 33 | ask questions on the [Ultralytics Community Forums](https://community.ultralytics.com/). 34 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-request.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | name: 🚀 Feature Request 4 | description: Suggest an Ultralytics software idea 5 | # title: " " 6 | labels: [enhancement] 7 | type: "feature" 8 | body: 9 | - type: markdown 10 | attributes: 11 | value: | 12 | Thank you for submitting an Ultralytics 🚀 Feature Request! 13 | 14 | - type: checkboxes 15 | attributes: 16 | label: Search before asking 17 | description: > 18 | Please search the Ultralytics [Docs](https://docs.ultralytics.com/) and [issues](https://github.com/ultralytics/template-rust/issues) to see if a similar feature request already exists. 19 | options: 20 | - label: > 21 | I have searched the Ultralytics [issues](https://github.com/ultralytics/template-rust/issues) and found no similar feature requests. 22 | required: true 23 | 24 | - type: textarea 25 | attributes: 26 | label: Description 27 | description: A short description of your feature. 28 | placeholder: | 29 | What new feature would you like to see in this Ultralytics project? 30 | validations: 31 | required: true 32 | 33 | - type: textarea 34 | attributes: 35 | label: Use case 36 | description: | 37 | Describe the use case of your feature request. It will help us understand and prioritize the feature request. 38 | placeholder: | 39 | How would this feature be used, and who would use it? 40 | 41 | - type: textarea 42 | attributes: 43 | label: Additional 44 | description: Anything else you would like to share? 45 | 46 | - type: checkboxes 47 | attributes: 48 | label: Are you willing to submit a PR? 49 | description: > 50 | (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/template-rust/pulls) (PR) to help improve Ultralytics software for everyone, especially if you have a good understanding of how to implement a fix or feature. 51 | See the Ultralytics [Contributing Guide](https://docs.ultralytics.com/help/contributing/) to get started. 52 | options: 53 | - label: Yes I'd like to help by submitting a PR! 54 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug-report.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | name: 🐛 Bug Report 4 | # title: " " 5 | description: Problems with Ultralytics software 6 | labels: [bug, triage] 7 | type: "bug" 8 | body: 9 | - type: markdown 10 | attributes: 11 | value: | 12 | Thank you for submitting an Ultralytics 🐛 Bug Report! 13 | 14 | - type: checkboxes 15 | attributes: 16 | label: Search before asking 17 | description: > 18 | Please search the Ultralytics [Docs](https://docs.ultralytics.com/) and [issues](https://github.com/ultralytics/template-rust/issues) to see if a similar bug report already exists. 19 | options: 20 | - label: > 21 | I have searched the Ultralytics [issues](https://github.com/ultralytics/template-rust/issues) and found no similar bug report. 22 | required: true 23 | 24 | - type: dropdown 25 | attributes: 26 | label: Ultralytics Component 27 | description: | 28 | Please select the component where you found the bug. 29 | multiple: true 30 | options: 31 | - "Install" 32 | - "Setup" 33 | - "Configuration" 34 | - "CLI" 35 | - "API" 36 | - "Training" 37 | - "Validation" 38 | - "Prediction" 39 | - "Export" 40 | - "Integration" 41 | - "Documentation" 42 | - "Other" 43 | validations: 44 | required: false 45 | 46 | - type: textarea 47 | attributes: 48 | label: Bug 49 | description: Please provide as much information as possible. Copy and paste console output and error messages including the _full_ traceback. Use [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format text, code and logs. If necessary, include screenshots for visual elements only. Providing detailed information will help us resolve the issue more efficiently. 50 | placeholder: | 51 | 💡 ProTip! Include as much information as possible (logs, tracebacks, screenshots, etc.) to receive the most helpful response. 52 | validations: 53 | required: true 54 | 55 | - type: textarea 56 | attributes: 57 | label: Environment 58 | description: Please provide your system information to help us diagnose the problem. 59 | placeholder: | 60 | Please include: 61 | - OS (e.g., Ubuntu 20.04, macOS 13.5, Windows 11) 62 | - Rust toolchain (e.g., rustc 1.78.0, cargo 1.78.0) 63 | - Crate version (e.g., cargo tree | grep ultralytics-template-rust) 64 | - Hardware (e.g., CPU, GPU model) 65 | - Any relevant environment details (shell, target triple, linker) 66 | 67 | Example: 68 | ``` 69 | OS: macOS-13.5.2 70 | Rust: rustc 1.78.0 (toolchain stable-x86_64-apple-darwin) 71 | Crate: ultralytics-template-rust 0.1.0 72 | Hardware: Apple M3, 16GB RAM, no GPU 73 | Environment: Terminal / zsh 74 | ``` 75 | validations: 76 | required: true 77 | 78 | - type: textarea 79 | attributes: 80 | label: Minimal Reproducible Example 81 | description: > 82 | When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimal reproducible example](https://docs.ultralytics.com/help/minimum-reproducible-example/). 83 | placeholder: | 84 | ```rust 85 | // Code to reproduce your issue here 86 | use ultralytics_template_rust::add_numbers; 87 | 88 | fn main() { 89 | let result = add_numbers(1, 2); 90 | println!("Result: {result}"); 91 | } 92 | ``` 93 | validations: 94 | required: true 95 | 96 | - type: textarea 97 | attributes: 98 | label: Additional 99 | description: Anything else you would like to share? 100 | 101 | - type: checkboxes 102 | attributes: 103 | label: Are you willing to submit a PR? 104 | description: > 105 | (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/template-rust/pulls) (PR) to help improve Ultralytics software for everyone, especially if you have a good understanding of how to implement a fix or feature. 106 | See the Ultralytics [Contributing Guide](https://docs.ultralytics.com/help/contributing/) to get started. 107 | options: 108 | - label: Yes I'd like to help by submitting a PR! 109 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license 2 | 3 | # Publish crate to crates.io https://crates.io/crates/ultralytics-template-rust 4 | 5 | name: Publish to crates.io 6 | 7 | on: 8 | push: 9 | branches: [main] 10 | workflow_dispatch: 11 | inputs: 12 | publish: 13 | type: boolean 14 | description: Publish to crates.io 15 | 16 | jobs: 17 | check: 18 | if: github.repository == 'ultralytics/template-rust' && github.actor == 'glenn-jocher' 19 | runs-on: ubuntu-latest 20 | permissions: 21 | contents: write 22 | outputs: 23 | increment: ${{ steps.check_version.outputs.increment }} 24 | current_tag: ${{ steps.check_version.outputs.current_tag }} 25 | previous_tag: ${{ steps.check_version.outputs.previous_tag }} 26 | crate_url: https://crates.io/crates/ultralytics-template-rust 27 | steps: 28 | - uses: actions/checkout@v6 29 | with: 30 | fetch-depth: 0 31 | - uses: actions/setup-python@v6 32 | with: 33 | python-version: "3.x" 34 | - uses: astral-sh/setup-uv@v7 35 | - name: Install ultralytics-actions 36 | run: uv pip install --system --no-cache ultralytics-actions 37 | - name: Fetch tags 38 | run: git fetch --tags --force 39 | - id: check_version 40 | shell: python 41 | run: | 42 | import os 43 | import re 44 | import subprocess 45 | 46 | version = None 47 | with open("Cargo.toml") as f: 48 | for line in f: 49 | m = re.search(r'version\s*=\s*"([^"]+)"', line) 50 | if m: 51 | version = m.group(1) 52 | break 53 | if not version: 54 | raise SystemExit("Version not found in Cargo.toml") 55 | 56 | current_tag = f"v{version}" 57 | tags = subprocess.run( 58 | ["git", "tag", "--sort=-creatordate"], 59 | text=True, 60 | capture_output=True, 61 | check=True, 62 | ).stdout.strip().splitlines() 63 | previous_tag = next((t for t in tags if t != current_tag), "") 64 | 65 | remote = subprocess.run( 66 | ["git", "ls-remote", "--tags", "origin", current_tag], 67 | text=True, 68 | capture_output=True, 69 | ) 70 | tag_exists = current_tag in tags or bool(remote.stdout.strip()) 71 | increment = str(not tag_exists) 72 | 73 | print(f"Local version: {version}") 74 | print(f"Current tag: {current_tag}") 75 | print(f"Previous tag: {previous_tag or ''}") 76 | print(f"Tag exists: {tag_exists}") 77 | 78 | os.system(f'echo "increment={increment}" >> $GITHUB_OUTPUT') 79 | os.system(f'echo "current_tag={current_tag}" >> $GITHUB_OUTPUT') 80 | os.system(f'echo "previous_tag={previous_tag}" >> $GITHUB_OUTPUT') 81 | if increment == "True": 82 | print("Ready to publish new version to crates.io ✅.") 83 | - name: Tag and Release 84 | if: steps.check_version.outputs.increment == 'True' 85 | env: 86 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 87 | CURRENT_TAG: ${{ steps.check_version.outputs.current_tag }} 88 | PREVIOUS_TAG: ${{ steps.check_version.outputs.previous_tag }} 89 | OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} 90 | run: | 91 | git config --global user.name "UltralyticsAssistant" 92 | git config --global user.email "web@ultralytics.com" 93 | git tag -a "$CURRENT_TAG" -m "$(git log -1 --pretty=%B)" 94 | git push origin "$CURRENT_TAG" 95 | ultralytics-actions-summarize-release 96 | uv cache prune --ci 97 | 98 | build: 99 | needs: check 100 | if: needs.check.outputs.increment == 'True' 101 | runs-on: ubuntu-latest 102 | permissions: 103 | contents: read 104 | steps: 105 | - uses: actions/checkout@v6 106 | - uses: dtolnay/rust-toolchain@nightly 107 | with: 108 | components: rustfmt, clippy 109 | - uses: Swatinem/rust-cache@v2 110 | - run: cargo fmt --all -- --check 111 | - run: cargo clippy --all-targets --all-features -- -D warnings 112 | - run: cargo test --all --all-features 113 | 114 | publish: 115 | needs: [check, build] 116 | if: needs.check.outputs.increment == 'True' 117 | runs-on: ubuntu-latest 118 | environment: 119 | name: Release - crates.io 120 | url: ${{ needs.check.outputs.crate_url }} 121 | permissions: 122 | contents: read 123 | steps: 124 | - uses: actions/checkout@v6 125 | - uses: dtolnay/rust-toolchain@stable 126 | - uses: Swatinem/rust-cache@v2 127 | - run: cargo publish 128 | env: 129 | CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} 130 | 131 | sbom: 132 | needs: [check, build, publish] 133 | if: needs.check.outputs.increment == 'True' 134 | runs-on: ubuntu-latest 135 | permissions: 136 | contents: write 137 | steps: 138 | - uses: actions/checkout@v6 139 | - uses: dtolnay/rust-toolchain@stable 140 | - uses: Swatinem/rust-cache@v2 141 | - name: Generate Cargo.lock for SBOM 142 | run: cargo generate-lockfile 143 | - uses: anchore/sbom-action@v0 144 | with: 145 | format: spdx-json 146 | output-file: sbom.spdx.json 147 | path: . 148 | - run: gh release upload ${{ needs.check.outputs.current_tag }} sbom.spdx.json 149 | env: 150 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 151 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Ultralytics logo 2 | 3 | # 🛠 Ultralytics Rust Project Template 4 | 5 | Welcome to the Ultralytics Rust Project Template! This repository provides a standardized foundation for initiating Rust 6 | projects at [Ultralytics](https://www.ultralytics.com/). It incorporates best practices in project structure, 7 | configuration, and essential tooling to streamline development. By using this template, Ultralytics developers can 8 | ensure consistency, maintain high quality standards, and accelerate the setup process for new Rust-based software. 9 | 10 | [![Template CI](https://github.com/ultralytics/template-rust/actions/workflows/ci.yml/badge.svg)](https://github.com/ultralytics/template-rust/actions/workflows/ci.yml) 11 | [![Ultralytics Actions](https://github.com/ultralytics/template-rust/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/template-rust/actions/workflows/format.yml) 12 | [![Publish](https://github.com/ultralytics/template-rust/actions/workflows/publish.yml/badge.svg)](https://github.com/ultralytics/template-rust/actions/workflows/publish.yml) 13 | [![codecov](https://codecov.io/gh/ultralytics/template-rust/graph/badge.svg?token=K9IunpFzjS)](https://codecov.io/gh/ultralytics/template-rust) 14 | [![Crates.io MSRV](https://img.shields.io/crates/msrv/ultralytics-template-rust)](https://github.com/ultralytics/template-rust/blob/main/Cargo.toml) 15 | 16 | [![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics) 17 | [![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/) 18 | [![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics) 19 | 20 | ## 🗂️ Repository Structure 21 | 22 | This template is organized for intuitive navigation and a clear understanding of Rust project components. 23 | 24 | - `src/lib.rs`: Core library code for the crate. 25 | - `src/main.rs`: Example binary entrypoint that exercises the library. 26 | - `tests/`: Integration tests executed with `cargo test`. 27 | - `docs/`: Optional Markdown docs that complement Rustdoc output. 28 | - `Cargo.toml`: Package metadata, dependencies, and workspace configuration. 29 | - `.gitignore`: Git ignore rules tailored for Cargo builds and IDEs. 30 | - `LICENSE`: Project license file (default AGPL-3.0-or-later). 31 | - `.github/workflows/`: GitHub Actions for CI, formatting, and publishing the crate. 32 | 33 | ```plaintext 34 | your-project/ 35 | │ 36 | ├── src/ # Library and binaries 37 | │ ├── lib.rs 38 | │ └── main.rs 39 | ├── tests/ # Integration tests 40 | │ └── basic.rs 41 | ├── docs/ # Additional Markdown docs (optional) 42 | │ └── README.md 43 | ├── .github/workflows/ # CI, formatting, publish pipelines 44 | │ ├── ci.yml 45 | │ ├── format.yml 46 | │ └── publish.yml 47 | ├── .gitignore # Git ignore rules for Rust 48 | ├── Cargo.toml # Cargo package metadata 49 | ├── LICENSE # Project license file 50 | └── README.md # This file 51 | ``` 52 | 53 | ### 📦 Source Code Directory (`src/`) 54 | 55 | The `src/` directory contains both the reusable library (`lib.rs`) and an example binary (`main.rs`). Expand the library 56 | with modules as the crate grows, and keep binaries thin wrappers that delegate to library functions. 57 | 58 | ### 🧪 Testing Directory (`tests/`) 59 | 60 | Integration tests in `tests/` validate user-facing behavior. Add unit tests alongside the code they cover in `src/` and 61 | run everything with `cargo test`. 62 | 63 | ### 📚 Documentation Directory (`docs/`) 64 | 65 | Keep Markdown guides in `docs/` for onboarding and architecture notes. Rustdoc generated from `src/` remains the source 66 | of truth for API documentation (`cargo doc --open`). 67 | 68 | ## ✨ Starting a New Project 69 | 70 | Kickstart your new Rust project using this template: 71 | 72 | 1. **Create Your Repository:** Click "Use this template" on GitHub to generate a new repository. Update the remote URL in 73 | your local clone. 74 | 2. **Customize:** Adjust `Cargo.toml` (package name, description, authors), refresh this `README.md`, and tailor 75 | `.github/workflows/*.yml` as needed. 76 | 3. **Develop:** Add modules to `src/lib.rs`, binaries to `src/bin/` or `src/main.rs`, and integration tests to `tests/`. 77 | 4. **Validate:** Run `cargo fmt`, `cargo clippy --all-targets --all-features -- -D warnings`, and `cargo test` locally. 78 | 5. **Document:** Keep code-level docs up to date with `///` comments and expand `docs/` for guides or ADRs. 79 | 80 | ## 🚀 Quickstart 81 | 82 | Install Rust via [rustup](https://rustup.rs/) and then: 83 | 84 | ```bash 85 | cargo fmt 86 | cargo test 87 | cargo run 88 | ``` 89 | 90 | Using the published crate from another project (after release): 91 | 92 | ```toml 93 | # Cargo.toml 94 | [dependencies] 95 | ultralytics-template-rust = "0.0.1" 96 | ``` 97 | 98 | ```rust 99 | use ultralytics_template_rust::add_numbers; 100 | 101 | fn main() { 102 | let sum = add_numbers(1, 2); 103 | println!("Sum: {sum}"); 104 | } 105 | ``` 106 | 107 | ### 🧾 Releases 108 | 109 | - Publishes on `main` pushes when a new `v` tag is needed; manual runs support `dry_run: true`. 110 | - Crate name: `ultralytics-template-rust`; tags follow `v` from `Cargo.toml`. 111 | - Requires repository secrets: `CARGO_REGISTRY_TOKEN` (crates.io), `GITHUB_TOKEN` (built-in), and `OPENAI_API_KEY` for AI release notes. 112 | - Workflow guards: fmt, clippy, tests must pass; tag/release are created only after a successful publish. 113 | 114 | ## 🔧 Utilizing the Template 115 | 116 | For Ultralytics team members and external contributors: 117 | 118 | - Clone the newly created repository based on this template to start working locally. 119 | - Keep `README.md` and `Cargo.toml` aligned with the crate’s purpose and public API. 120 | - Extend CI jobs if you add features like WebAssembly targets, feature-flag matrices, or documentation publishing. 121 | 122 | With this template, Ultralytics aims to foster a culture of excellence and uniformity in Rust software development, 123 | ensuring every project starts on a solid foundation aligned with industry standards and organizational best practices. 124 | 125 | ## 💡 Contribute 126 | 127 | Ultralytics thrives on community collaboration, and we deeply value your contributions! Whether it's reporting bugs, 128 | suggesting features, or submitting code changes, your involvement is crucial. 129 | 130 | - **Reporting Issues:** Encounter a bug? Please report it on [GitHub Issues](https://github.com/ultralytics/template-rust/issues). 131 | - **Feature Requests:** Have an idea for improvement? Share it via [GitHub Issues](https://github.com/ultralytics/template-rust/issues). 132 | - **Pull Requests:** Want to contribute code? Please read our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) first, then submit a Pull Request. 133 | - **Feedback:** Share your thoughts and experiences by participating in our official [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). 134 | 135 | A heartfelt thank you 🙏 goes out to all our contributors! Your efforts help make Ultralytics tools better for everyone. 136 | 137 | [![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors) 138 | 139 | ## 📄 License 140 | 141 | Ultralytics offers two licensing options to accommodate diverse needs: 142 | 143 | - **AGPL-3.0 License**: Ideal for students, researchers, and enthusiasts passionate about open collaboration and 144 | knowledge sharing. This [OSI-approved](https://opensource.org/license/agpl-v3) open-source license promotes 145 | transparency and community involvement. See the [LICENSE](LICENSE) file for details. 146 | - **Enterprise License**: Designed for commercial applications, this license permits the seamless integration of 147 | Ultralytics software and AI models into commercial products and services, bypassing the copyleft requirements of 148 | AGPL-3.0. For commercial use cases, please inquire about an 149 | [Ultralytics Enterprise License](https://www.ultralytics.com/license). 150 | 151 | ## 📮 Contact 152 | 153 | For bug reports or feature suggestions related to this template or other Ultralytics projects, please use 154 | [GitHub Issues](https://github.com/ultralytics/template-rust/issues). For general questions, discussions, and community 155 | support, join our [Discord](https://discord.com/invite/ultralytics) server! 156 | 157 |
158 |
159 | Ultralytics GitHub 160 | space 161 | Ultralytics LinkedIn 162 | space 163 | Ultralytics Twitter 164 | space 165 | Ultralytics YouTube 166 | space 167 | Ultralytics TikTok 168 | space 169 | Ultralytics BiliBili 170 | space 171 | Ultralytics Discord 172 |
173 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------