ADD: Setup epoch repo

threecgreen · threecgreen · commit 786c8b42ee4f · 2025-09-11T09:43:55.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,15 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+
+# Added by cargo
+
+/target
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+info@nautechsystems.io.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,4 @@
+Thank you for taking the time to contribute to our project.
+We welcome feedback through discussions and issues on GitHub, as well as our [community Slack](https://databento.com/support).
+While we don't merge pull requests directly due to the open-source repository being a downstream
+mirror of our internal codebase, we can commit the changes upstream with the original author.
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,24 @@
+[package]
+name = "epoch"
+authors = ["Databento <support@databento.com>"]
+version = "0.3.0"
+edition = "2021"
+repository = "https://github.com/databento/epoch"
+description = "CLI tool for converting UNIX timestamps to human-readable date strings"
+license = "Apache-2.0"
+# maximum of 5
+keywords = ["epoch", "timestamps"]
+# see https://crates.io/category_slugs
+categories = ["command-line-utilities", "date-and-time", "value-formatting"]
+
+
+[dependencies]
+anyhow = "1.0.98"
+chrono = "0.4.41"
+clap = { version = "4.5", features = ["derive", "wrap_help"] }
+
+[dev-dependencies]
+# CLI integration tests
+assert_cmd = "2.0"
+predicates = "3.1"
+rstest = "0.26"
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Zach Banks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# epoch
+
+[![build](https://github.com/databento/epoch/actions/workflows/build.yaml/badge.svg)](https://github.com/databento/epoch/actions/workflows/build.yaml)
+[![license](https://img.shields.io/github/license/databento/epoch?color=blue)](./LICENSE)
+[![Current Crates.io Version](https://img.shields.io/crates/v/epoch-cli.svg)](https://crates.io/crates/epoch-cli)
+
+Utility for making UNIX timestamps human-readable
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -0,0 +1,6 @@
+#! /usr/bin/env bash
+set -e
+
+cargo --version
+echo build all
+cargo build --all-features
diff --git a/scripts/format.sh b/scripts/format.sh
@@ -0,0 +1,3 @@
+#! /usr/bin/env bash
+cargo --version
+cargo fmt --check # fails if anything is misformatted
diff --git a/scripts/get_version.sh b/scripts/get_version.sh
@@ -0,0 +1,5 @@
+#! /usr/bin/env bash
+
+SCRIPTS_DIR="$(cd "$(dirname "$0")" || exit; pwd -P)"
+PROJECT_ROOT_DIR="$(dirname "${SCRIPTS_DIR}")"
+grep -E '^version =' "${PROJECT_ROOT_DIR}/Cargo.toml" | cut -d'"' -f 2
diff --git a/scripts/lint.sh b/scripts/lint.sh
@@ -0,0 +1,5 @@
+#! /usr/bin/env bash
+set -e
+
+cargo --version
+cargo clippy --all-features -- --deny warnings
diff --git a/scripts/test.sh b/scripts/test.sh
@@ -0,0 +1,5 @@
+#! /usr/bin/env bash
+set -e
+
+cargo --version
+cargo test --all-features
diff --git a/src/main.rs b/src/main.rs
@@ -0,0 +1,162 @@
+use std::{
+    fs::File,
+    io::{stdin, stdout, BufRead, BufReader, BufWriter, Write},
+    ops::{Range, RangeInclusive},
+    path::PathBuf,
+};
+
+use chrono::{DateTime, Local, SecondsFormat, TimeZone};
+use clap::Parser;
+
+#[derive(Parser, Debug)]
+#[clap(version, about)]
+struct Args {
+    /// Input file to read from; omit reading from STDIN or arguments
+    #[clap(short, long, value_name = "FILE")]
+    input: Option<PathBuf>,
+    /// Output file to write to; omit writing to STDOUT
+    #[clap(short, long, value_name = "FILE")]
+    output: Option<PathBuf>,
+    /// Threshold for detecting dates, in +/- years
+    #[clap(short, long, value_name = "YEARS", default_value_t = 8)]
+    threshold: i32,
+    /// Localize timestamps
+    #[clap(short, long)]
+    local: bool,
+    /// Quote formatted timestamps with `"..."`
+    #[clap(short, long)]
+    quote: bool,
+    /// If provided, convert command line arguments instead of STDIN or a file
+    #[clap(value_name = "TEXT")]
+    strings: Vec<String>,
+}
+
+#[derive(Debug)]
+struct Reformatter {
+    min_len: usize,
+    bound_s: Range<i64>,
+    bound_ms: Range<i64>,
+    bound_ns: Range<i64>,
+    localize: bool,
+    quote: bool,
+}
+
+impl Reformatter {
+    fn new(threshold_years: i32, localize: bool, quote: bool) -> Self {
+        // This is only used as a (generous) heuristic, so it's OK to approximate here
+        let dt = chrono::Duration::days(threshold_years.abs() as i64 * 365);
+        let now = chrono::offset::Utc::now();
+        let upper_s: i64 = (now + dt).timestamp();
+        let lower_s: i64 = (now - dt).timestamp();
+        let bound_s = lower_s..upper_s;
+        let bound_ms = lower_s * 1_000..upper_s * 1_000;
+        let bound_ns = lower_s * 1_000_000_000..upper_s * 1_000_000_000;
+
+        Reformatter {
+            min_len: format!("{lower_s}").len(),
+            bound_s,
+            bound_ms,
+            bound_ns,
+            localize,
+            quote,
+        }
+    }
+
+    fn write<T: Write>(&self, writer: &mut T, line: &str) -> anyhow::Result<()> {
+        const NUMBERS: RangeInclusive<char> = '0'..='9';
+        // let line = line.as_bytes();
+        let mut text_iter = line.char_indices().peekable();
+        while let Some((text_start, _c)) = text_iter.peek() {
+            let text_start = *text_start;
+            // Otherwise, no timestamp found
+            let Some((number_start, _)) = text_iter.find(|(_, c)| NUMBERS.contains(c)) else {
+                write!(writer, "{}", &line[text_start..])?;
+                break;
+            };
+            // Find index of first non-number character after `number_start`. We know this character
+            // isn't a number, so print it as `text_after`
+            let (number_end, text_after) = text_iter
+                .find(|(_, c)| !NUMBERS.contains(c))
+                .map(|(i, _)| (i, &line[i..i + 1]))
+                .unwrap_or_else(|| (line.len(), ""));
+
+            // If the length of the number is less than that of the lower second bound, can skip parsing
+            if (number_end - number_start) >= self.min_len {
+                let number: &str = &line[number_start..number_end];
+                let parse_result = number.parse().ok().and_then(|n| {
+                    if self.bound_s.contains(&n) {
+                        Some((n * 1_000_000_000, SecondsFormat::Secs))
+                    } else if self.bound_ms.contains(&n) {
+                        Some((n * 1_000_000, SecondsFormat::Millis))
+                    } else if self.bound_ns.contains(&n) {
+                        Some((n, SecondsFormat::Nanos))
+                    } else {
+                        None
+                    }
+                });
+                if let Some((time_ns, sec_fmt)) = parse_result {
+                    let time = chrono::Utc.timestamp_nanos(time_ns);
+                    let text_before = &line[text_start..number_start];
+                    let time = if self.localize {
+                        DateTime::<Local>::from(time).format(Self::rfc_format::<true>(sec_fmt))
+                    } else {
+                        time.format(Self::rfc_format::<false>(sec_fmt))
+                    };
+                    if self.quote {
+                        write!(writer, "{text_before}\"{time}\"{text_after}")
+                    } else {
+                        write!(writer, "{text_before}{time}{text_after}")
+                    }?;
+                    continue;
+                }
+            }
+            // plus 1 for text_after
+            let text = &line[text_start..(number_end + 1).min(line.len())];
+            write!(writer, "{text}",)?;
+        }
+        Ok(())
+    }
+
+    const fn rfc_format<const LOCALIZE: bool>(sec_fmt: SecondsFormat) -> &'static str {
+        match (LOCALIZE, sec_fmt) {
+            (true, SecondsFormat::Secs) => "%Y-%m-%dT%H:%M:%S%Z",
+            (false, SecondsFormat::Secs) => "%Y-%m-%dT%H:%M:%SZ",
+            (true, SecondsFormat::Millis) => "%Y-%m-%dT%H:%M:%S%.3f%Z",
+            (false, SecondsFormat::Millis) => "%Y-%m-%dT%H:%M:%S%.3fZ",
+            (true, _) => "%Y-%m-%dT%H:%M:%S%.9f%Z",
+            (false, _) => "%Y-%m-%dT%H:%M:%S%.9fZ",
+        }
+    }
+}
+
+fn main() -> anyhow::Result<()> {
+    let args = Args::parse();
+
+    let reformatter = Reformatter::new(args.threshold, args.local, args.quote);
+    let mut output: Box<dyn Write> = if let Some(path) = args.output {
+        Box::new(BufWriter::new(File::create(path)?))
+    } else {
+        Box::new(BufWriter::new(stdout().lock()))
+    };
+
+    if let Some(input_file) = args.input {
+        for line in BufReader::new(File::open(input_file)?).lines() {
+            reformatter.write(&mut output, &line?)?;
+            output.write_all(b"\n")?;
+        }
+    } else if let Some((last, rest)) = args.strings.split_last() {
+        for arg in rest {
+            reformatter.write(&mut output, arg)?;
+            output.write_all(b" ")?;
+        }
+        reformatter.write(&mut output, last)?;
+        output.write_all(b"\n")?;
+    } else {
+        for line in stdin().lock().lines() {
+            reformatter.write(&mut output, &line?)?;
+            output.write_all(b"\n")?;
+        }
+    }
+
+    Ok(())
+}
diff --git a/tests/integration_tests.rs b/tests/integration_tests.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#! /usr/bin/env bash`
	`2`	`+cargo --version`
	`3`	`+cargo fmt --check # fails if anything is misformatted`