Skip to content

Commit c714878

Browse files
committed
docs: Update crate level docs and package metadata
1 parent 7bf8962 commit c714878

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

Cargo.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
name = "python3-dll-a"
33
version = "0.2.1"
44
edition = "2021"
5-
description = "Standalone python3.dll import library generator"
5+
description = "Standalone python3(y).dll import library generator"
66
repository = "https://github.com/pyo3/python3-dll-a"
7-
authors = ["Sergey Kvachonok <[email protected]>", "messense <[email protected]>"]
8-
license = "MIT AND PSF-2.0"
9-
keywords = ["build-dependencies", "python", "windows", "mingw"]
7+
authors = ["Sergey Kvachonok <[email protected]>", "messense <[email protected]>", "Adam Reichold <[email protected]>"]
8+
license = "MIT"
9+
keywords = ["build-dependencies", "python", "windows", "mingw", "msvc"]
1010
categories = ["development-tools::build-utils"]
1111
readme = "README.md"
1212

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 Sergey Kvachonok, Adam Reichold
3+
Copyright (c) 2022 Sergey Kvachonok, Adam Reichold, messense <[email protected]>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
Standalone `python3.dll` import library generator
2-
=================================================
1+
Standalone `python3(y).dll` import library generator
2+
====================================================
33

4-
Generates import libraries for the Stable ABI Python DLL
4+
Generates import libraries for the Python DLL
5+
(either `python3.dll` or `python3y.dll`)
56
for MinGW-w64 and MSVC (cross-)compile targets.
67

7-
See <https://docs.python.org/3/c-api/stable.html> for details.
8+
See <https://docs.python.org/3/c-api/stable.html> for the Stable ABI details.
89

910
This crate **does not require** Python 3 distribution files
1011
to be present on the (cross-)compile host system.
1112

12-
**Note:** MSVC (cross-)compile targets require LLVM binutils
13+
**Note:** MSVC cross-compile targets require LLVM binutils
1314
to be available on the host system.
1415
More specifically, `python3-dll-a` requires `llvm-dlltool` executable
15-
to be present in `PATH` when targeting `*-pc-windows-msvc`.
16+
to be present in `PATH` when targeting `*-pc-windows-msvc` from Linux.
1617

1718
PyO3 integration
1819
----------------
@@ -79,7 +80,5 @@ This crate embeds Module-Defitions based on the `stable_abi.toml` file from CPyt
7980

8081
The upstream version of this file is located in the [CPython project][cpython]
8182
repository under the path `Misc/stable_abi.toml`.
82-
This file should be updated for every subsequent CPython release
83-
(e.g. for CPython 3.12).
8483

8584
[cpython]: https://github.com/python/cpython/blob/main/Misc/stable_abi.toml

src/lib.rs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
//! Standalone `python3.dll` import library generator
2-
//! =================================================
1+
//! Standalone `python3(y).dll` import library generator
2+
//! ====================================================
33
//!
4-
//! Generates import libraries for the Stable ABI Python DLL
4+
//! Generates import libraries for the Python DLL
5+
//! (either `python3.dll` or `python3y.dll`)
56
//! for MinGW-w64 and MSVC (cross-)compile targets.
67
//!
7-
//! See <https://docs.python.org/3/c-api/stable.html> for details.
8+
//! See <https://docs.python.org/3/c-api/stable.html> for the Stable ABI details.
89
//!
910
//! This crate **does not require** Python 3 distribution files
1011
//! to be present on the (cross-)compile host system.
1112
//!
12-
//! **Note:** MSVC (cross-)compile targets require LLVM binutils
13+
//! **Note:** MSVC cross-compile targets require LLVM binutils
1314
//! to be available on the host system.
1415
//! More specifically, `python3-dll-a` requires `llvm-dlltool` executable
15-
//! to be present in `PATH` when targeting `*-pc-windows-msvc`.
16+
//! to be present in `PATH` when targeting `*-pc-windows-msvc` from Linux.
1617
//!
1718
//! PyO3 integration
1819
//! ----------------

0 commit comments

Comments
 (0)