Struct pyproject_toml::Project

pub struct Project {

    pub name: String,
    pub version: Option<Version>,
    pub description: Option<String>,
    pub readme: Option<ReadMe>,
    pub requires_python: Option<VersionSpecifiers>,
    pub license: Option<License>,
    pub license_files: Option<LicenseFiles>,
    pub authors: Option<Vec<Contact>>,
    pub maintainers: Option<Vec<Contact>>,
    pub keywords: Option<Vec<String>>,
    pub classifiers: Option<Vec<String>>,
    pub urls: Option<IndexMap<String, String>>,
    pub entry_points: Option<IndexMap<String, IndexMap<String, String>>>,
    pub scripts: Option<IndexMap<String, String>>,
    pub gui_scripts: Option<IndexMap<String, String>>,
    pub dependencies: Option<Vec<Requirement>>,
    pub optional_dependencies: Option<IndexMap<String, Vec<Requirement>>>,
    pub dynamic: Option<Vec<String>>,
}

PEP 621 project metadata

Fields

name: String

The name of the project

version: Option<Version>

The version of the project as supported by PEP 440

description: Option<String>

The summary description of the project

readme: Option<ReadMe>

The full description of the project (i.e. the README)

requires_python: Option<VersionSpecifiers>

The Python version requirements of the project

license: Option<License>

License

license_files: Option<LicenseFiles>

License Files (PEP 639) - https://peps.python.org/pep-0639/#add-license-files-key

authors: Option<Vec<Contact>>

The people or organizations considered to be the “authors” of the project

maintainers: Option<Vec<Contact>>

Similar to “authors” in that its exact meaning is open to interpretation

keywords: Option<Vec<String>>

The keywords for the project

classifiers: Option<Vec<String>>

Trove classifiers which apply to the project

urls: Option<IndexMap<String, String>>

A table of URLs where the key is the URL label and the value is the URL itself

entry_points: Option<IndexMap<String, IndexMap<String, String>>>

Entry points

scripts: Option<IndexMap<String, String>>

Corresponds to the console_scripts group in the core metadata

gui_scripts: Option<IndexMap<String, String>>

Corresponds to the gui_scripts group in the core metadata

dependencies: Option<Vec<Requirement>>

Project dependencies

optional_dependencies: Option<IndexMap<String, Vec<Requirement>>>

Optional dependencies

dynamic: Option<Vec<String>>

Specifies which fields listed by PEP 621 were intentionally unspecified so another tool can/will provide such metadata dynamically.

Implementations

impl Project

pub fn new(name: String) -> Self

Initializes the only field mandatory in PEP 621 (name) and leaves everything else empty

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Project

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Project

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Project

fn eq(&self, other: &Project) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Project

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Project

impl StructuralPartialEq for Project