Depends-On: #6

Description: Create a paket regarding to the paket type of PackageType::Configuration

Configuration type means "just copy the files inside the paket to their regarding paths in the system":

• {PaketRoot}/etc/X11/xorg.conf -> /etc/X11/xorg.conf
• {PaketRoot}/$USER_HOME/.config/monitors.xml -> /home/my-user/.config/monitors.xml (accessing the home folder of the current user by creating a "$USER_HOME" folder)
• {PaketRoot}/$ALL_USERS_HOMES/.config/monitors.xml -> ["/home/my-user/.config/monitors.xml", "/home/user2/.config/monitors.xml", ...] (accessing the home folders of all users by creating a "$ALL_USERS_HOMES")

Acceptance Criteria:

• [x] Local paket can be created successfully.
• [x] Tests are passing.
• [x] Documentations on every struct, property and function is written with ///. There should be a description and a small example usage.

Implementation Details:

// Some example code about how it will work

Description: This is the first task of Creating a Paket milestone.

Every different building type have common things like creating a tar.gz package, calculating SHA256SUM etc.

Acceptance Criteria:

• [x] Common functions implemented
• [x] Tests are passing.
• [x] Documentations on every struct, property and function is written with ///. There should be a description and a small example usage.

Implementation Details:

// Some example code about how it will work

Description: paket-cli and paket-server can depend on libpaket which consists common structures and functions to work with paket's.

Acceptance Criteria:

• [x] paket-cli and paket-server depends on libpaket.
• [x] libpaket consists common paket structures and functions. Prevents code duplication on paket-cli and paket-server with common code.
• [x] Tests are passing.
• [x] Documentations on every struct, property and function is written with ///. There should be a description and a small example usage.

Implementation Details:

Acceptance Criteria:

• [x] Separate cli module for cli handling paket-cli can handle these CLI inputs:
• [x] paket build
• [x] paket install <packages>...
• [x] paket remove <packages>...
• [x] paket search <keywords>...

Implementation Details: Use clap crate. Define build, install etc. as commands.

Acceptance Criteria:

• [ ] Dependencies struct implemented and added in Config
• [ ] Basic tests are working. (tests/toml_parse.rs)
• [ ] Full tests are working. (tests/toml_parse.rs)
• [ ] Documentations on every struct, property and function is written with /// three slashes.

Implementation Details: Config Struct:

#[derive(Deserialize, Serialize)]
struct Config {
    package: Package,
    dependencies: Option<Dependencies>,
}

Dependencies Struct:

#[derive(Deserialize, Serialize)]
struct Dependencies {
    application: Option<Vec<String>>,
    library: Option<Vec<String>>,
    development: Option<Vec<String>>,
}

These fields may be updated, names may change or new fields may be added.

Example Paket.toml:

[package]
name = "paket-ornek"
version = "0.1.0"
maintainers = ["Emin Fedar <[email protected]>"]

description = "A paket package example."
license = "MIT"

architectures = ["amd64"]

[dependencies]
application = ["python3.11", "python3-gi"]
library = ["libgtk-3-0", "libglib2.0.0", "libpango-1.0-0"]
# development = ["libgtk-3-0-dev"] # This field is only needed if the paket type is Source Code

Acceptance Criteria:

• [x] Package and Config structs implemented
• [x] Reading & Parsing Paket.toml is working.
• [x] Basic, Full, and wrong content contained Paket.toml files and corresponding tests are working.(tests/toml_parse.rs)

Implementation Details: Config struct:

#[derive(Debug, Deserialize)]
struct Config {
    package: Package,
}

Package struct corresponding to the [package] title in the .toml file:

#[derive(Debug, Deserialize)]
struct Package {
    // ------------- Must Fields -------------
    name: String,
    version: String,
    maintainers: Vec<String>,
    description: String,
    license: String,
    architectures: Vec<String>,

    // ------------- Optional Fields -------------
    homepage: Option<String>,
    keywords: Option<Vec<String>>,
    categories: Option<Vec<String>>,
}

These fields may be updated, names may change or new fields may be added.

Example "Basic" Paket.toml:

[package]
name = "paket-ornek"
version = "0.1.0"
maintainers = ["Emin Fedar <[email protected]>"]

description = "A paket package example."
license = "MIT"

architectures = ["amd64"]

Example "Full" Paket.toml:

[package]
name = "hello-world"
version = "0.1.0"
maintainers = ["Emin Fedar <[email protected]>"]

homepage = "pardus.org.tr"
keywords = ["package", "tags", "here"]
categories = ["Game", "Education"]

license = "MIT"
architectures = ["amd64"]

description = """
Multiline description of what this package is about.
"""

Description: a local .paket file builded with Configuration type should be installable with this usage:

paket install paket-name_1.0.0.paket

Configuration type means "just copy the files inside the paket to their regarding paths in the system":

• {PaketRoot}/etc/X11/xorg.conf -> /etc/X11/xorg.conf
• {PaketRoot}/$USER_HOME/.config/monitors.xml -> /home/my-user/.config/monitors.xml (accessing the home folder of the current user by creating a "$USER_HOME" folder)
• {PaketRoot}/$ALL_USERS_HOMES/.config/monitors.xml -> [ "/home/my-user/.config/monitors.xml", "/home/user2/.config/monitors.xml", "/home/another-user/.config/monitors.xml", ] (accessing the home folders of all users by creating a "$ALL_USERS_HOMES")

Acceptance Criteria:

• [ ] Local paket can be installed successfully.
• [ ] Installed pakets are stored in /var folder.
• [ ] Upgrading or Downgrading for same package.
• [ ] SHA256SUM check before installation
• [ ] Files in $USER_HOME must be owned by the installer user, not root.
• [ ] Files in $ALL_USERS_HOMES must owned by each different user, not root or installer user.
• [ ] Tests are passing.
• [ ] Documentations on every struct, property and function is written with ///. There should be a description and a small example usage.

Implementation Details:

// Some example code about how it will work

Description: Create a paket regarding to the paket type of these:

• PackageType::Application
• PackageType::Script
• PackageType::Library
• PackageType::DevelopmentLibrary

UPDATED: These fields not in their final form, constantly updated. Custom Fields for Types:

• PackageType::Application =>

[application]
executable = "myapp"
icon = "myapp.svg"

assets_folder = "assets" # stores the assets(image,video,sound,binary,text data etc.) in paket folder. like: assets/img/logo.png, assets/sound/intro.ogg, assets/3d_objects/My3DModel.obj
desktop_file = "assets/export/myapp.desktop" # optional, automatically generated if not provided

• PackageType::Script =>

[script]
executable = "main.py" # To create link `/usr/bin/myapp` -> `/usr/share/paketname/src/main.py`
icon = "myapp.svg"

sources_folder = "src" # stores the scripts in paket folder. like: src/main.py, src/MainWindow.py, src/Utils.py
assets_folder = "assets" # stores the assets(image,video,sound,binary,text data etc.) in paket folder. like: assets/img/logo.png, assets/sound/intro.ogg, assets/3d_objects/My3DModel.obj
desktop_file = "assets/export/myapp.desktop"  # optional, automatically generated if not provided

TODO: These package types have custom fields. Application & Script types have executable stores the binary which makes paket manage application and script pakets more powerful. (will work on these fields, program files which stored on /usr/share for scripting files? etc.) Libraries also should be powerful to work on. paket should know if it is an archive .a or .so file only etc. Also Application or Script packages automatically create .desktop files with paket information while installing.

Acceptance Criteria:

• [ ] Local paket can be builded and created successfully.
• [ ] Different build tactics for different PackageTypes. (maybe?)
• [ ] Tests are passing.
• [ ] Documentations on every struct, property and function is written with ///. There should be a description and a small example usage.

Implementation Details:

// Some example code about how it will work