{"id":17946592,"url":"https://github.com/defstream/kickable-rs","last_synced_at":"2025-03-24T20:32:48.769Z","repository":{"id":65378394,"uuid":"581241668","full_name":"defstream/kickable-rs","owner":"defstream","description":"Can you kick it?","archived":false,"fork":false,"pushed_at":"2025-03-17T11:13:34.000Z","size":12734,"stargazers_count":6,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T01:52:11.689Z","etag":null,"topics":["it","kickable","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/defstream.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-12-22T16:41:45.000Z","updated_at":"2024-09-05T08:59:35.000Z","dependencies_parsed_at":"2023-02-24T17:00:54.948Z","dependency_job_id":"266142d8-a8a6-486e-b081-eec95282c1c8","html_url":"https://github.com/defstream/kickable-rs","commit_stats":{"total_commits":429,"total_committers":5,"mean_commits":85.8,"dds":0.08857808857808858,"last_synced_commit":"56caa74cd2392c0d07857072d284526d1cd72467"},"previous_names":[],"tags_count":135,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defstream%2Fkickable-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defstream%2Fkickable-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defstream%2Fkickable-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defstream%2Fkickable-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/defstream","download_url":"https://codeload.github.com/defstream/kickable-rs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245195931,"owners_count":20575937,"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":["it","kickable","rust"],"created_at":"2024-10-29T07:06:44.729Z","updated_at":"2025-03-24T20:32:48.252Z","avatar_url":"https://github.com/defstream.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://media2.giphy.com/media/p3R62d6L0WYw0/200w.gif\"\u003e\n\u003c/p\u003e\n\n[![crate status](https://img.shields.io/crates/v/kickable.svg)](https://crates.io/crates/kickable)\n[![branch status](https://github.com/defstream/kickable-rs/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/defstream/kickable-rs/actions/workflows/main.yml)\n[![ci status](https://dl.circleci.com/status-badge/img/gh/defstream/kickable-rs/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/defstream/kickable-rs/tree/main)\n[![travis status](https://app.travis-ci.com/defstream/kickable-rs.svg?branch=main)](https://app.travis-ci.com/defstream/kickable-rs)\n[![coveralls status](https://coveralls.io/repos/github/defstream/kickable-rs/badge.svg?branch=main)](https://coveralls.io/github/defstream/kickable-rs?branch=main)\n[![codecov status](https://codecov.io/gh/defstream/kickable-rs/branch/main/graph/badge.svg?token=JHAZGUBEC8)](https://codecov.io/gh/defstream/kickable-rs)\n[![docs status](https://readthedocs.org/projects/kickable-rs/badge/?version=latest)](https://readthedocs.org/projects/kickable-rs)\n![GitHub Sponsors](https://img.shields.io/github/sponsors/defstream) \n[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7146/badge)](https://bestpractices.coreinfrastructure.org/projects/7146)\n\n\n# kickable\n**kickable** is a crate created to answer the age old question... \"_Can I Kick It?_\"\n_This package is for showcase purposes only._\n\n**What is a kickable?**\nCurrently only the word \"it\" is kickable.\n\n## Library\n\n### Install\n\nUse the kickable library in your project by adding it to your Cargo.toml file.\n\n```shell\n$ cargo add kickable\n```\n\n### Usage\n\n```rust\nuse kickable;\n\nfn main() {\n    let kickable = kickable::validate(\"it\");\n    println!(\"Can you kick it? {kickable}\");\n}\n```\n\n## CLI\n\n### Install\n\nDownload the binary from the releases page and place it in your path, or if you have cargo installed.\n\n```bash\n$ cargo install kickable\n```\n\n### Usage\nObtain help about the kickable cli.\n\n```shell\n$ kickable --help\nkickable is a crate created to answer the age old question... Can I kick it?\n\nUsage: kickable [OPTIONS] \u003cITEM\u003e\n\nArguments:\n  \u003cITEM\u003e  The item to check for kick-ability\n\nOptions:\n  -c, --config \u003cCONFIG\u003e  The path to the configuration file [default: kickable.yaml]\n  -h, --help             Print help\n  -V, --version          Print version\n\n```\n\nAn example of the most basic usage of the kickable cli.\n```shell\n$ kickable \"it\"\nYes, yes you can.\n\n```\n\n### Configuration\nBelow is an example of an optional kickable configuration file. \n\n```yaml\n# items that are kickable\nitems:\n  - it   # English\n  - él   # Spanish\n  - el   # Spanish\n  - それ  # Japanese\n  - il   # French\n\n# language preferred for i18n messages\nlang: en-US # default language\n\n# logging configuration\nlogging:\n  level: 1 # 1: debug, 2: info, 3: warning, 4: error, 5: critical\n  file: /var/log/kickable # log file path\n\n# server configuration\nserver:\n  addr: 0.0.0.0 # address to bind to\n  port: 8080 # port number\n\n# client configuration\nclient:\n  addr: 0.0.0.0 # address to connect to\n  port: 8080 # port number\n```\n\n\n## Maintainers\nHector Gray (\u003ca href=\"https://hectorgray.com\"\u003e@defstream\u003c/a\u003e)\n\n## Contribute\nPull Requests welcome. Please make sure all tests pass 😀\n\n## License\nKickable by \u003ca href=\"https://twitter.com/defstream\"\u003eHector Gray\u003c/a\u003e is marked with CC0 1.0 Universal. To view a copy of this license, visit http://creativecommons.org/publicdomain/zero/1.0\n\n[![license](https://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0kickable)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefstream%2Fkickable-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefstream%2Fkickable-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefstream%2Fkickable-rs/lists"}