-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d6b95e6
commit ec715ec
Showing
10 changed files
with
242 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,85 @@ | ||
| use aqora_config::ReadMe; | ||
| use mime::Mime; | ||
| use std::path::Path; | ||
| use std::path::{Path, PathBuf}; | ||
| use thiserror::Error; | ||
|
|
||
| #[derive(Debug, Error)] | ||
| pub enum ReadMeError { | ||
| pub enum ReadmeError { | ||
| #[error(transparent)] | ||
| Io(#[from] std::io::Error), | ||
| #[error("Readme not found")] | ||
| #[error("README not found")] | ||
| NotFound, | ||
| #[error("Readme content type not supported. Only markdown and plaintext supported")] | ||
| #[error("README content type not supported. Only markdown and plaintext supported")] | ||
| ContentTypeNotSupported, | ||
| } | ||
|
|
||
| pub async fn read_readme( | ||
| pub async fn get_readme_path( | ||
| project_dir: impl AsRef<Path>, | ||
| readme: Option<&ReadMe>, | ||
| ) -> Result<Option<String>, ReadMeError> { | ||
| ) -> Result<Option<PathBuf>, ReadmeError> { | ||
| let path = match readme { | ||
| Some(ReadMe::Table { | ||
| ref file, | ||
| text, | ||
| text: _, | ||
| content_type, | ||
| }) => { | ||
| let path: Option<&Path> = file.as_deref().map(str::as_ref); | ||
| if let Some(content_type) = content_type { | ||
| let mime: Mime = content_type | ||
| .parse() | ||
| .map_err(|_| ReadMeError::ContentTypeNotSupported)?; | ||
| .map_err(|_| ReadmeError::ContentTypeNotSupported)?; | ||
| if !(mime.type_() == mime::TEXT | ||
| && (mime.subtype() == mime::PLAIN || mime.subtype() == "markdown")) | ||
| { | ||
| return Err(ReadMeError::ContentTypeNotSupported); | ||
| return Err(ReadmeError::ContentTypeNotSupported); | ||
| } | ||
| } | ||
| if let Some(text) = text { | ||
| return Ok(Some(text.to_owned())); | ||
| } | ||
| path | ||
| path.map(|p| p.to_path_buf()) | ||
| } | ||
| Some(ReadMe::RelativePath(ref path)) => Some(path.as_ref()), | ||
| Some(ReadMe::RelativePath(ref path)) => Some(PathBuf::from(path)), | ||
| None => None, | ||
| }; | ||
| let path = if let Some(path) = path { | ||
| project_dir.as_ref().join(path) | ||
| } else { | ||
| let mut dir = tokio::fs::read_dir(&project_dir).await?; | ||
| let mut path = None; | ||
| while let Some(entry) = dir.next_entry().await? { | ||
| match entry.file_name().to_string_lossy().to_lowercase().as_str() { | ||
| "readme.md" | "readme.txt" => {} | ||
| _ => continue, | ||
| } | ||
| let metadata = entry.metadata().await?; | ||
| if !metadata.is_file() { | ||
| continue; | ||
| } | ||
| path = Some(entry.path()); | ||
| break; | ||
|
|
||
| if let Some(path) = path { | ||
| return Ok(Some(path)); | ||
| } | ||
|
|
||
| let mut dir = tokio::fs::read_dir(&project_dir).await?; | ||
| while let Some(entry) = dir.next_entry().await? { | ||
| match entry.file_name().to_string_lossy().to_lowercase().as_str() { | ||
| "readme.md" | "readme.txt" => {} | ||
| _ => continue, | ||
| } | ||
| if let Some(path) = path { | ||
| path | ||
| } else { | ||
| return Ok(None); | ||
| let metadata = entry.metadata().await?; | ||
| if metadata.is_file() { | ||
| return Ok(Some(entry.path())); | ||
| } | ||
| } | ||
|
|
||
| Ok(None) | ||
| } | ||
|
|
||
| pub async fn read_readme( | ||
| project_dir: impl AsRef<Path>, | ||
| readme: Option<&ReadMe>, | ||
| ) -> Result<Option<String>, ReadmeError> { | ||
| let path = match get_readme_path(project_dir, readme).await? { | ||
| Some(path) => path, | ||
| None => return Ok(None), | ||
| }; | ||
|
|
||
| match path | ||
| .extension() | ||
| .map(|ext| ext.to_string_lossy().to_lowercase()) | ||
| .as_deref() | ||
| { | ||
| Some("md") | Some("txt") | None => {} | ||
| _ => { | ||
| return Err(ReadMeError::ContentTypeNotSupported); | ||
| } | ||
| _ => return Err(ReadmeError::ContentTypeNotSupported), | ||
| } | ||
|
|
||
| if !tokio::fs::try_exists(&path).await? { | ||
| return Err(ReadMeError::NotFound); | ||
| return Err(ReadmeError::NotFound); | ||
| } | ||
|
|
||
| Ok(Some(tokio::fs::read_to_string(path).await?)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Byte-compiled / optimized / DLL files | ||
| __pycache__/ | ||
| *.py[cod] | ||
|
|
||
| # C extensions | ||
| *.so | ||
|
|
||
| # Distribution / packaging | ||
| bin/ | ||
| build/ | ||
| develop-eggs/ | ||
| dist/ | ||
| eggs/ | ||
| lib/ | ||
| lib64/ | ||
| parts/ | ||
| sdist/ | ||
| var/ | ||
| *.egg-info/ | ||
| .installed.cfg | ||
| *.egg | ||
|
|
||
| # Installer logs | ||
| pip-log.txt | ||
| pip-delete-this-directory.txt | ||
|
|
||
| # Unit test / coverage reports | ||
| .tox/ | ||
| .coverage | ||
| .cache | ||
| nosetests.xml | ||
| coverage.xml | ||
|
|
||
| # Translations | ||
| *.mo | ||
|
|
||
| # Mr Developer | ||
| .mr.developer.cfg | ||
| .project | ||
| .pydevproject | ||
|
|
||
| # Rope | ||
| .ropeproject | ||
|
|
||
| # Django stuff: | ||
| *.log | ||
| *.pot | ||
|
|
||
| # Sphinx documentation | ||
| docs/_build/ | ||
|
|
||
| # aqora | ||
| .aqora | ||
| .venv | ||
| __aqora__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
|  | ||
| rr | ||
|  | ||
|
|
||
| # test Submission | ||
|
|
||
| You can find a template notebook in `submission/solution.ipynb`. | ||
| Fill in your solution. You can run the notebook locally to test your | ||
| solution by running the following in the terminal | ||
|
|
||
| ```bash | ||
| aqora test | ||
| ``` | ||
|
|
||
| And when you are ready to submit run | ||
|
|
||
| ```bash | ||
| aqora upload | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| [project] | ||
| name = "submission" | ||
| version = "0.1.3" | ||
| requires-python = ">=3.8" | ||
| readme = "README.md" | ||
|
|
||
| # You can add dependencies with `aqora add` | ||
| dependencies = [] | ||
|
|
||
| [build-system] | ||
| requires = [ | ||
| "uv>=0.4.20", | ||
| "setuptools>=75", | ||
| "wheel>=0.44", | ||
| ] | ||
| build-backend = "setuptools.build_meta" | ||
|
|
||
| [tool.setuptools.packages.find] | ||
| where = ["."] | ||
| [tool.setuptools.package-data] | ||
| submission = ["*"] | ||
|
|
||
| [tool.aqora] | ||
| type = "submission" | ||
| competition = "test" | ||
|
|
||
| [tool.aqora.refs] | ||
| solution = { path = "submission.solution", notebook = true } |
Oops, something went wrong.