{"id":15908206,"url":"https://github.com/wilhelmagren/docstring-rs","last_synced_at":"2025-03-22T00:31:33.783Z","repository":{"id":196380808,"uuid":"695939180","full_name":"wilhelmagren/docstring-rs","owner":"wilhelmagren","description":"📒 Generate or update docstrings for new and existing files.","archived":false,"fork":false,"pushed_at":"2024-03-06T09:00:27.000Z","size":24,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T06:34:55.124Z","etag":null,"topics":["automation","cli","documentation","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wilhelmagren.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-24T17:08:28.000Z","updated_at":"2023-10-04T22:24:59.000Z","dependencies_parsed_at":"2024-10-28T11:51:34.136Z","dependency_job_id":null,"html_url":"https://github.com/wilhelmagren/docstring-rs","commit_stats":{"total_commits":19,"total_committers":2,"mean_commits":9.5,"dds":"0.10526315789473684","last_synced_commit":"2de2f5dbda4ff752697e84ccd46adcf3c3aa62c6"},"previous_names":["wilhelmagren/docstring-rs"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilhelmagren%2Fdocstring-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilhelmagren%2Fdocstring-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilhelmagren%2Fdocstring-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilhelmagren%2Fdocstring-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wilhelmagren","download_url":"https://codeload.github.com/wilhelmagren/docstring-rs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244890102,"owners_count":20527030,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cli","documentation","rust"],"created_at":"2024-10-06T14:12:00.780Z","updated_at":"2025-03-22T00:31:33.435Z","avatar_url":"https://github.com/wilhelmagren.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cbr/\u003e\n\u003cdiv align=\"left\"\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n\u003c/p\u003e\n\u003c/div\u003e\n\n[![Crates.io (latest)](https://img.shields.io/crates/v/docstring-rs)](https://crates.io/crates/docstring-rs)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![codecov](https://codecov.io/gh/wilhelmagren/docstring-rs/graph/badge.svg?token=DAOMDVU8QF)](https://codecov.io/gh/wilhelmagren/docstring-rs)\n[![CI](https://github.com/wilhelmagren/docstring-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/wilhelmagren/docstring-rs/actions/workflows/ci.yml)\n[![Tests](https://github.com/wilhelmagren/docstring-rs/actions/workflows/tests.yml/badge.svg)](https://github.com/wilhelmagren/docstring-rs/actions/workflows/tests.yml)\n\n\u003c/div\u003e\n\n## 🔎 Overview\nAutomatically generate new files or update existing codebases with header docstrings based on LICENSE information.\n\n## 📦 Installation\n```\ncargo install docstring-rs\n```\n\n## 🚀 Usage\n```\nUsage: docstring-rs.exe [OPTIONS] --directory \u003cDIRECTORY\u003e\n\nOptions:\n  -d, --directory \u003cDIRECTORY\u003e  Name of the directory in which to create new file or update existing files,\n                               if it does not already exist, creates the directory\n  -f, --file \u003cFILE_NAME\u003e       Name of a new file to create with docstring as header. Prepends to top of\n                               file if the target file already exists [default: *.*]\n  -l, --license \u003cLICENSE\u003e      Relative path to the LICENSE file to use as header docstring. If not specified,\n                               expects a LICENSE file to exist in the current working directory [default: LICENSE]\n  -u, --update                 Specify whether or not to try and update all available docstrings in a directory\n                               recursively, requires \u003cDIRECTORY\u003e to have been set\n  -h, --help                   Print help\n  -V, --version                Print version\n```\n\n## 📋 License\nAll code is to be held under a general MIT license, please see [LICENSE](https://github.com/wilhelmagren/docstring-rs/blob/main/LICENSE) for specific information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilhelmagren%2Fdocstring-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwilhelmagren%2Fdocstring-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilhelmagren%2Fdocstring-rs/lists"}