Skip to content

Commit d9b46e3

Browse files
committed
Prepare crate for publishing to crates.io
Rename crate from agentic-framework to agentum, add required metadata (description, license, repository, keywords, categories), add MIT LICENSE file, add .gitignore, and exclude non-essential files from the package.
1 parent 7dc31a2 commit d9b46e3

14 files changed

Lines changed: 53 additions & 23 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target
2+
Cargo.lock

‎Cargo.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
[package]
2-
name = "agentic-framework"
2+
name = "agentum"
33
version = "0.1.0"
44
edition = "2021"
5+
description = "A minimal Rust library for building LLM-powered applications through DAG-based workflows"
6+
license = "MIT"
7+
repository = "https://github.com/mfaulk/agentum"
8+
readme = "README.md"
9+
keywords = ["llm", "agent", "workflow", "ai", "openai"]
10+
categories = ["asynchronous", "web-programming"]
11+
exclude = [".planning/", "agentum-banner.png"]
512

613
[dependencies]
714
tokio = { version = "1.49", features = ["full"] }

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Matt Faulk
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ cargo run --example simple_chat
2222
### Single LLM Call
2323

2424
```rust
25-
use agentic_framework::{Message, Model, ModelOptions, ModelResponse, OpenAiProvider};
25+
use agentum::{Message, Model, ModelOptions, ModelResponse, OpenAiProvider};
2626

2727
#[tokio::main]
28-
async fn main() -> agentic_framework::Result<()> {
28+
async fn main() -> agentum::Result<()> {
2929
let provider = OpenAiProvider::from_env("gpt-4o-mini")?;
3030
let messages = vec![
3131
Message::system("You are a helpful assistant."),
@@ -44,7 +44,7 @@ async fn main() -> agentic_framework::Result<()> {
4444
### Tool Calling
4545

4646
```rust
47-
use agentic_framework::{Tool, ToolRegistry, Model, Message, ModelOptions, ModelResponse, OpenAiProvider};
47+
use agentum::{Tool, ToolRegistry, Model, Message, ModelOptions, ModelResponse, OpenAiProvider};
4848
use async_trait::async_trait;
4949

5050
struct Calculator;
@@ -60,14 +60,14 @@ impl Tool for Calculator {
6060
"required": ["expression"]
6161
})
6262
}
63-
async fn execute(&self, args: serde_json::Value) -> agentic_framework::Result<String> {
63+
async fn execute(&self, args: serde_json::Value) -> agentum::Result<String> {
6464
let expr = args["expression"].as_str().unwrap_or("0");
6565
Ok(format!("Result: {expr}"))
6666
}
6767
}
6868

6969
#[tokio::main]
70-
async fn main() -> agentic_framework::Result<()> {
70+
async fn main() -> agentum::Result<()> {
7171
let provider = OpenAiProvider::from_env("gpt-4o-mini")?;
7272
let mut registry = ToolRegistry::new();
7373
registry.register(Calculator)?;
@@ -92,11 +92,11 @@ async fn main() -> agentic_framework::Result<()> {
9292
### Workflow Pipeline
9393

9494
```rust
95-
use agentic_framework::{Model, OpenAiProvider, Workflow};
95+
use agentum::{Model, OpenAiProvider, Workflow};
9696
use serde_json::json;
9797

9898
#[tokio::main]
99-
async fn main() -> agentic_framework::Result<()> {
99+
async fn main() -> agentum::Result<()> {
100100
let provider = OpenAiProvider::from_env("gpt-4o-mini")?;
101101

102102
let workflow = Workflow::builder()

‎examples/simple_chat.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
//!
1818
//! Requires the `OPENAI_API_KEY` environment variable to be set.
1919
20-
use agentic_framework::{Message, Model, ModelOptions, ModelResponse, OpenAiProvider};
20+
use agentum::{Message, Model, ModelOptions, ModelResponse, OpenAiProvider};
2121

2222
#[tokio::main]
2323
async fn main() {

‎examples/tool_calling.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
//!
2020
//! Requires the `OPENAI_API_KEY` environment variable to be set.
2121
22-
use agentic_framework::error::Result;
23-
use agentic_framework::{
22+
use agentum::error::Result;
23+
use agentum::{
2424
Message, Model, ModelOptions, ModelResponse, OpenAiProvider, Tool, ToolRegistry,
2525
};
2626
use async_trait::async_trait;

‎examples/workflow.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
//!
2626
//! Requires the `OPENAI_API_KEY` environment variable to be set.
2727
28-
use agentic_framework::{Model, OpenAiProvider, Workflow};
28+
use agentum::{Model, OpenAiProvider, Workflow};
2929
use serde_json::json;
3030

3131
/// A short article to summarize and translate.

‎src/error.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ pub enum Error {
4646
Config(String),
4747
}
4848

49-
/// Convenience Result alias for the agentic-framework library.
49+
/// Convenience Result alias for the agentum library.
5050
pub type Result<T> = std::result::Result<T, Error>;
5151

5252
/// Errors that can occur during workflow construction via [`WorkflowBuilder`].

‎src/lib.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # Agentic Framework
1+
//! # Agentum
22
//!
33
//! A minimal Rust library for building LLM-powered applications through
44
//! DAG-based workflows. Provides core abstractions for model interaction,
@@ -24,7 +24,7 @@ pub mod openai;
2424
pub mod workflow;
2525

2626
// Re-export primary types for convenience.
27-
// Users can `use agentic_framework::{Model, Message, ...}` instead of
27+
// Users can `use agentum::{Model, Message, ...}` instead of
2828
// reaching into submodules.
2929
pub use error::{BuilderError, BuilderErrors, Error, Result};
3030
pub use message::{Message, Role};

0 commit comments

Comments
 (0)