update

emo-crab · Dec 15, 2023 · 11051dc · 11051dc
1 parent da0971c
commit 11051dc
Show file tree

Hide file tree

Showing 16 changed files with 111 additions and 9 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,13 +1,16 @@
-[package]
-name = "notion-rs" #改这个
+[workspace.package]
+#name = "notion-rs" #改这个
 version = "0.1.0"
 edition = "2021"
 authors = ["Kali-Team <root@kali-team.cn>"]
 include = ["LICENSE", "Cargo.toml", "src/**/*.rs"]
+license-file = "LICENSE"
+license = "GPL-3.0-only"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [workspace]
 members = ["notion-sdk"]
+resolver = "2"
 
 #https://github.com/johnthagen/min-sized-rust
 [profile.release]
@@ -29,4 +32,5 @@ codegen-units = 1
 opt-level = 3
 
 
-[dependencies]
+[workspace.dependencies]
+notion-sdk = { path = "notion-sdk", version = "0.1.0" }
diff --git a/notion-sdk/Cargo.toml b/notion-sdk/Cargo.toml
@@ -1,7 +1,13 @@
 [package]
 name = "notion-sdk"
-version = "0.1.0"
 edition = "2021"
+description = "A rust implementation of the nvd-yew."
+homepage = "https://github.com/emo-crab/notion-rs"
+repository = "https://github.com/emo-crab/notion-rs"
+authors = ["Kali-Team <root@kali-team.cn>"]
+readme = "README.md"
+license = "GPL-3.0-only"
+version = "0.0.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/notion-sdk/README.md b/notion-sdk/README.md
@@ -0,0 +1,8 @@
+## Notion SDK
+
+[![github]](https://github.com/emo-crab/notion-rs)&ensp;[![crates-io]](https://crates.io/crates/notion-sdk)&ensp;[![docs-rs]](crate)
+[github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
+
+- UnOfficial Notion SDK mplemented by rust
diff --git a/notion-sdk/src/block/mod.rs b/notion-sdk/src/block/mod.rs
@@ -1,3 +1,16 @@
+//!
+//! # Notion Block
+//!
+//! ## Examples
+//! ```rust,no_run
+//! use notion_sdk::block::TextAndChildren;
+//! use notion_sdk::common::rich_text::TextColor;
+//! let text = TextAndChildren{
+//!     rich_text: vec![],
+//!     children: None,
+//!     color: TextColor::Default
+//! };
+//! ```
 mod api;
 mod code;
 pub mod id;

diff --git a/notion-sdk/src/comment/mod.rs b/notion-sdk/src/comment/mod.rs
@@ -1 +1,3 @@
-
+//!
+//! # Notion Comment
+//!
diff --git a/notion-sdk/src/common/mod.rs b/notion-sdk/src/common/mod.rs
@@ -1,3 +1,6 @@
+//!
+//! # Notion Common
+//!
 pub mod aka;
 pub mod file;
 pub mod parent;

diff --git a/notion-sdk/src/common/rich_text.rs b/notion-sdk/src/common/rich_text.rs
@@ -71,7 +71,7 @@ pub struct Text {
     pub link: Option<Link>,
 }
 
-/// See https://developers.notion.com/reference/rich-text#mention-objects
+/// See <https://developers.notion.com/reference/rich-text#mention-objects>
 #[derive(Serialize, Deserialize, Debug, Eq, PartialEq, Clone)]
 #[serde(tag = "type")]
 #[serde(rename_all = "snake_case")]

diff --git a/notion-sdk/src/database/mod.rs b/notion-sdk/src/database/mod.rs
@@ -1,3 +1,17 @@
+//!
+//! # Notion DataBase
+//!
+//! ## Examples
+//! ```rust,no_run
+//! use notion_sdk::common::parent::Parent;
+//! use notion_sdk::database::CreateDatabase;
+//! use notion_sdk::database::properties::Properties;
+//! let database = CreateDatabase{
+//!     parent: Parent::Workspace,
+//!     title: vec![],
+//!     properties: Properties { properties: Default::default()},
+//! };
+//! ```
 pub mod properties;
 
 use crate::common::file::FileOrEmojiObject;

diff --git a/notion-sdk/src/error.rs b/notion-sdk/src/error.rs
@@ -1,9 +1,12 @@
+//!
+//! # Notion Error
+//!
 use crate::pagination::Object;
 use serde::{Deserialize, Serialize};
 use std::fmt::{Debug, Display, Formatter};
 use std::num::NonZeroU16;
 
-/// An wrapper Error type for all errors produced by the [`NotionApi`](NotionApi) client.
+/// An wrapper Error type for all errors produced by the NotionApi client.
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
     #[error("Invalid UUID: {}", source)]

diff --git a/notion-sdk/src/lib.rs b/notion-sdk/src/lib.rs
@@ -1,3 +1,23 @@
+//! [![github]](https://github.com/emo-crab/notion-rs)&ensp;[![crates-io]](https://crates.io/crates/notion-sdk)&ensp;[![docs-rs]](crate)
+//!
+//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
+//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
+//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
+//!
+//!
+//! UnOfficial Notion SDK mplemented by rust
+//!
+//!
+//! ## Examples
+//! ```rust,no_run
+//! use notion_sdk::NotionApi;
+//! async fn main(){
+//!     let notion = NotionApi::new("token")?;
+//!     let me = notion.users_me().await;
+//!     println!("{:#?}", me);
+//! }
+//!
+//! ```
 pub mod block;
 pub mod comment;
 pub mod common;
@@ -14,14 +34,17 @@ use reqwest::{ClientBuilder, RequestBuilder};
 
 const NOTION_API_VERSION: &str = "2022-02-22";
 
+/// Notion Api Client
 #[derive(Debug, Clone)]
 pub struct NotionApi {
     base_path: String,
     client: reqwest::Client,
 }
 
+/// new a notion api client with api token
 impl NotionApi {
-    pub fn new(api_token: String) -> Result<Self, Error> {
+    pub fn new<T>(api_token: T) -> Result<Self, Error> where
+        T: Into<String>, {
         let mut headers = reqwest::header::HeaderMap::new();
         headers.insert(
             "Notion-Version",
@@ -43,7 +66,7 @@ impl NotionApi {
 }
 
 impl NotionApi {
-    pub async fn request(&self, request: RequestBuilder) -> Result<Object, Error> {
+    async fn request(&self, request: RequestBuilder) -> Result<Object, Error> {
         let request = request.build()?;
         let json = self
             .client

diff --git a/notion-sdk/src/pages/aka.rs b/notion-sdk/src/pages/aka.rs
@@ -2,6 +2,7 @@ use crate::database::properties::PropertyValue;
 use crate::pages::Page;
 
 impl Page {
+    /// get page's title
     pub fn get_title(&self) -> String {
         if let Some(PropertyValue::Title { title, .. }) = self.properties.properties.get("Title") {
             let tit: Vec<String> = title.iter().map(|r| r.plain_text().to_string()).collect();

diff --git a/notion-sdk/src/pages/mod.rs b/notion-sdk/src/pages/mod.rs
@@ -1,3 +1,18 @@
+//!
+//! # Notion Page
+//!
+//! ## Examples
+//! ```rust,no_run
+//! use notion_sdk::common::parent::Parent;
+//! use notion_sdk::database::properties::Properties;
+//! use notion_sdk::pages::CreatePage;
+//! let page = CreatePage{
+//!     icon: None,
+//!     parent: Parent::Workspace,
+//!     properties: Properties { properties: Default::default()},
+//!     children: vec![],
+//! };
+//! ```
 mod aka;
 mod api;
 mod builder;

diff --git a/notion-sdk/src/pagination.rs b/notion-sdk/src/pagination.rs
@@ -1,3 +1,6 @@
+//!
+//! # Notion Pagination
+//!
 use crate::block::Block;
 use crate::database::properties::PropertyValue;
 use crate::database::Database;

diff --git a/notion-sdk/src/search/mod.rs b/notion-sdk/src/search/mod.rs
@@ -1,3 +1,6 @@
+//!
+//! # Notion Search
+//!
 mod api;
 
 use crate::pages::id::PageId;

diff --git a/notion-sdk/src/user/api.rs b/notion-sdk/src/user/api.rs
@@ -4,6 +4,7 @@ use crate::{Error, NotionApi, Object};
 const ROUTER: &str = "users";
 
 impl NotionApi {
+    /// list users
     pub async fn users_list(&self) -> Result<Object, Error> {
         let u = format!("{}/{}", self.base_path, ROUTER);
         self.request(self.client.get(u)).await

diff --git a/notion-sdk/src/user/mod.rs b/notion-sdk/src/user/mod.rs
@@ -1,3 +1,6 @@
+//!
+//! # Notion User
+//!
 mod api;
 pub mod id;
 mod tests;