chore: Prepare packages for publishing

leo91000 · Dec 19, 2022 · 5d99f5c · 5d99f5c
1 parent 9ea0a52
commit 5d99f5c
Show file tree

Hide file tree

Showing 18 changed files with 75 additions and 25 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,15 @@
 [package]
 name = "archimedes"
-version = "0.1.0"
+version = "0.0.1"
 edition = "2021"
+license = "MIT"
+description = "High performance Rust/PostgreSQL job queue (also suitable for getting jobs generated by PostgreSQL triggers/functions out into a different work queue)"
+homepage = "docs.rs/archimedes"
+documentation = "docs.rs/archimedes"
+repository = "https://github.com/leo91000/archimedes"
+readme = "README.md"
+keywords = ["worker", "scheduler", "job scheduler", "async", "multithread"]
+categories = ["job-scheduler", "worker", "multithread", "async", "tokio"]
 
 [workspace]
 members = [
@@ -10,17 +18,17 @@ members = [
 
 [features]
 default = ["runtime-tokio-native-tls"]
-runtime-tokio-rustls = ["sqlx/runtime-tokio-rustls", "tokio", "crontab_runner/runtime-tokio-rustls", "archimedes_migrations/runtime-tokio-rustls"]
-runtime-tokio-native-tls = ["sqlx/runtime-tokio-native-tls", "tokio", "crontab_runner/runtime-tokio-native-tls", "archimedes_migrations/runtime-tokio-native-tls"]
+runtime-tokio-rustls = ["sqlx/runtime-tokio-rustls", "tokio", "archimedes_crontab_runner/runtime-tokio-rustls", "archimedes_migrations/runtime-tokio-rustls"]
+runtime-tokio-native-tls = ["sqlx/runtime-tokio-native-tls", "tokio", "archimedes_crontab_runner/runtime-tokio-native-tls", "archimedes_migrations/runtime-tokio-native-tls"]
 # For now we don't support async std
 # runtime-async-std-rustls = ["sqlx/runtime-async-std-rustls"]
 # runtime-async-std-native-tls = ["sqlx/runtime-async-std-native-tls"]
 
 [dependencies]
-crontab_runner = { path = "./crates/crontab_runner" }
-crontab_types = { path = "./crates/crontab_types" }
-crontab_parser = { path = "./crates/crontab_parser" }
-archimedes_migrations = { path = "./crates/migrations" }
+archimedes_crontab_runner = { path = "./crates/crontab_runner", version = "0.1.0" }
+archimedes_crontab_types = { path = "./crates/crontab_types", version = "0.1.0" }
+archimedes_crontab_parser = { path = "./crates/crontab_parser", version = "0.1.0" }
+archimedes_migrations = { path = "./crates/migrations", version = "0.1.0" }
 chrono = { version = "0.4.23", features = ["serde"] }
 futures = "0.3.25"
 getset = "0.1.2"

diff --git a/crates/crontab_parser/Cargo.toml b/crates/crontab_parser/Cargo.toml
@@ -1,12 +1,20 @@
 [package]
-name = "crontab_parser"
+name = "archimedes_crontab_parser"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "Crontab parsing package for archimedes, a high performance Rust/PostgreSQL job queue"
+homepage = "docs.rs/archimedes_crontab_parser"
+documentation = "docs.rs/archimedes_crontab_parser"
+repository = "https://github.com/leo91000/archimedes/crates/crontab_parser"
+keywords = ["worker", "scheduler", "job scheduler", "async", "multithread"]
+categories = ["job-scheduler", "worker", "multithread", "async", "tokio"]
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-crontab_types = { path = "../crontab_types" }
+archimedes_crontab_types = { path = "../crontab_types" }
 json5 = "0.4.1"
 nom = "7.1.1"
 serde = { version = "1.0.151", features = ["derive"] }

diff --git a/crates/crontab_parser/README.md b/crates/crontab_parser/README.md
@@ -0,0 +1,3 @@
+# Crontab parser
+
+This crate a crontab parser for the [Archimedes](docs.rs/archimedes) job scheduler
diff --git a/crates/crontab_parser/src/lib.rs b/crates/crontab_parser/src/lib.rs
@@ -1,4 +1,4 @@
-pub use crontab_types::Crontab;
+pub use archimedes_crontab_types::Crontab;
 pub use nom::error::ErrorKind;
 use nom_crontab::nom_crontab;
 use thiserror::Error;

diff --git a/crates/crontab_parser/src/nom_crontab.rs b/crates/crontab_parser/src/nom_crontab.rs
@@ -56,7 +56,7 @@ pub(crate) fn nom_crontab(input: &str) -> IResult<&str, Vec<Crontab>> {
 mod tests {
     use serde_json::json;
 
-    use crontab_types::{CrontabFill, CrontabOptions, CrontabTimer, CrontabValue};
+    use archimedes_crontab_types::{CrontabFill, CrontabOptions, CrontabTimer, CrontabValue};
 
     use super::*;
 

diff --git a/crates/crontab_parser/src/nom_crontab_opts.rs b/crates/crontab_parser/src/nom_crontab_opts.rs
@@ -7,7 +7,7 @@ use nom::{
 };
 use serde::Deserialize;
 
-use crontab_types::{CrontabFill, CrontabOptions};
+use archimedes_crontab_types::{CrontabFill, CrontabOptions};
 
 #[derive(Deserialize)]
 struct QueryOption<'a> {

diff --git a/crates/crontab_parser/src/nom_crontab_timer.rs b/crates/crontab_parser/src/nom_crontab_timer.rs
@@ -7,7 +7,7 @@ use nom::{
     IResult,
 };
 
-use crontab_types::{CrontabTimer, CrontabValue};
+use archimedes_crontab_types::{CrontabTimer, CrontabValue};
 
 #[derive(Debug, PartialEq, Eq)]
 enum CrontabPart {

diff --git a/crates/crontab_runner/Cargo.toml b/crates/crontab_runner/Cargo.toml
@@ -1,15 +1,22 @@
 [package]
-name = "crontab_runner"
-version = "0.0.0"
+name = "archimedes_crontab_runner"
+version = "0.1.0"
 edition = "2021"
+description = "Crontab runner package for archimedes, a high performance Rust/PostgreSQL job queue"
+homepage = "docs.rs/archimedes_crontab_runner"
+documentation = "docs.rs/archimedes_crontab_runner"
+repository = "https://github.com/leo91000/archimedes/crates/crontab_runner"
+keywords = ["worker", "scheduler", "job scheduler", "async", "multithread"]
+categories = ["job-scheduler", "worker", "multithread", "async", "tokio"]
+readme = "README.md"
 
 [features]
 default = ["runtime-tokio-native-tls"]
 runtime-tokio-rustls = ["sqlx/runtime-tokio-rustls", "tokio"]
 runtime-tokio-native-tls = ["sqlx/runtime-tokio-native-tls", "tokio"]
 
 [dependencies]
-crontab_types = { path = "../crontab_types" }
+archimedes_crontab_types = { path = "../crontab_types" }
 chrono = { version = "0.4.23", features = ["serde"] }
 sqlx = { version = "0.6.2", features = ["chrono"] }
 thiserror = "1.0.38"

diff --git a/crates/crontab_runner/README.md b/crates/crontab_runner/README.md
@@ -0,0 +1,3 @@
+# Crontab runner
+
+This crate is the crontab runner for the [Archimedes](docs.rs/archimedes) job scheduler
diff --git a/crates/crontab_runner/src/backfill.rs b/crates/crontab_runner/src/backfill.rs
@@ -1,5 +1,5 @@
+use archimedes_crontab_types::Crontab;
 use chrono::prelude::*;
-use crontab_types::Crontab;
 use sqlx::PgExecutor;
 use tracing::debug;
 

diff --git a/crates/crontab_runner/src/lib.rs b/crates/crontab_runner/src/lib.rs
@@ -1,8 +1,8 @@
 use std::cmp::Ordering;
 
+use archimedes_crontab_types::Crontab;
 use backfill::register_and_backfill_items;
 use chrono::prelude::*;
-use crontab_types::Crontab;
 use sqlx::PgExecutor;
 use tracing::{debug, warn};
 

diff --git a/crates/crontab_runner/src/sql.rs b/crates/crontab_runner/src/sql.rs
@@ -1,5 +1,5 @@
+use archimedes_crontab_types::Crontab;
 use chrono::prelude::*;
-use crontab_types::Crontab;
 use getset::Getters;
 use serde::Serialize;
 use serde_json::json;

diff --git a/crates/crontab_types/Cargo.toml b/crates/crontab_types/Cargo.toml
@@ -1,7 +1,14 @@
 [package]
-name = "crontab_types"
-version = "0.0.0"
+name = "archimedes_crontab_types"
+version = "0.1.0"
 edition = "2021"
+description = "Crontab types package for archimedes, a high performance Rust/PostgreSQL job queue"
+homepage = "docs.rs/archimedes_crontab_types"
+documentation = "docs.rs/archimedes_crontab_types"
+repository = "https://github.com/leo91000/archimedes/crates/crontab_types"
+keywords = ["worker", "scheduler", "job scheduler", "async", "multithread"]
+categories = ["job-scheduler", "worker", "multithread", "async", "tokio"]
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/crates/crontab_types/README.md b/crates/crontab_types/README.md
@@ -0,0 +1,3 @@
+# Crontab types
+
+This crate provides types and utilities for the [Archimedes](docs.rs/archimedes) job scheduler
diff --git a/crates/crontab_types/src/lib.rs b/crates/crontab_types/src/lib.rs
@@ -65,7 +65,7 @@ impl CrontabFill {
     /// Convert a crontab fill to a number of seconds
     ///
     /// ```rust
-    /// use crontab_types::CrontabFill;
+    /// use archimedes_crontab_types::CrontabFill;
     ///
     /// let fill = CrontabFill::new(1, 30, 28, 350, 2);
     /// assert_eq!(3318602, fill.to_secs());
@@ -103,7 +103,7 @@ impl CrontabTimer {
     /// Check if the timer should run at specifed date
     ///
     /// ```rust
-    /// use crontab_types::{CrontabValue, CrontabTimer};
+    /// use archimedes_crontab_types::{CrontabValue, CrontabTimer};
     ///
     /// let crontab_timer = CrontabTimer {
     ///     minutes: vec![CrontabValue::Number(30)],

diff --git a/crates/migrations/Cargo.toml b/crates/migrations/Cargo.toml
@@ -1,7 +1,15 @@
 [package]
 name = "archimedes_migrations"
-version = "0.0.0"
+version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "Migrations package for archimedes, a high performance Rust/PostgreSQL job queue"
+homepage = "docs.rs/archimedes_migrations"
+documentation = "docs.rs/archimedes_migrations"
+repository = "https://github.com/leo91000/archimedes/crates/migrations"
+keywords = ["worker", "scheduler", "job scheduler", "async", "multithread"]
+categories = ["job-scheduler", "worker", "multithread", "async", "tokio"]
+readme = "README.md"
 
 [features]
 default = ["runtime-tokio-native-tls"]

diff --git a/crates/migrations/README.md b/crates/migrations/README.md
@@ -0,0 +1,3 @@
+# Archimedes migrations
+
+This package provide the migrations for the [Archimedes](docs.rs/archimedes) job scheduler.
diff --git a/src/lib.rs b/src/lib.rs
@@ -5,7 +5,7 @@ mod sql;
 mod streams;
 mod utils;
 
-pub use crontab_parser::parse_crontab;
+pub use archimedes_crontab_parser::parse_crontab;
 
 pub use builder::{WorkerBuildError, WorkerOptions};
 pub use runner::{Worker, WorkerContext};